From 0ebf1ea8978344ec5f69e081e3ee7c8ff41602c2 Mon Sep 17 00:00:00 2001
From: rautenberg <rautenberg@in-silico.ch>
Date: Tue, 23 Aug 2016 18:28:57 +0200
Subject: Add QPRF reporting and change name to qsar-report

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 41 insertions(+), 10 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 655a8d4..1b71cbc 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,18 @@
-# lazar-report
-QMRF reporting extension to OpenTox ruby modules and lazar
+# QSAR-Report
+QMRF and QPRF reporting extension to OpenTox ruby modules and lazar
 ## About
-Class for QMRF reporting. 
-Provides a ruby OpenTox class to prepare an initial version of a QMRF report. 
-The XML output is in QMRF version 1.3 and can be finalized with the QMRF editor 2.0 (https://sourceforge.net/projects/qmrf/)  
-
-
+Class for QMRF and QPRF reporting.
+* QMRF:
+  Provides a ruby OpenTox class to prepare an initial version of a QMRF report.
+  The XML output is in QMRF version 1.3 and can be finalized with the QMRF editor 2.0 (https://sourceforge.net/projects/qmrf/)
+* QPRF:
+  Provides a ruby OpenTox class to prepare an initial version of a QPRF report in JSON or HTML.
 
 ## Usage
-create a new report, add some content and show output:
-```ruby 
-require "qmrf-report"
+### QMRF
+create a new QMRF report, add some content and show output:
+```ruby
+require "qsar-report"
 
 # create a new report
 report = OpenTox::QMRFReport.new
@@ -30,3 +32,32 @@ puts report.to_xml
 # validate a report (as created above) against qmrf.xsd
 report.validate
 ```
+### QPRF
+create a new QPRF report, add some content and show output:
+```ruby
+require "qsar-report"
+
+# create a new QPRF report instance
+report = OpenTox::QPRFReport.new
+
+# Set Title of the report
+report.Title = "My QPRF Report"
+
+# Set Version
+report.Version = "1"
+
+# Set Date
+report.Date = Time.now.strftime("%Y/%m/%d")
+
+# Set the CAS number in chapter 1.1
+report.Value "1.1", "7732-18-5" # set CAS number for H²O
+
+# print HTML version
+puts report.to_html
+
+# print formated JSON version
+puts report.pretty_json
+
+```
+
+
-- 
cgit v1.2.3