From 2cea3e57d26406aaaafb80011a9f6e65c150481f Mon Sep 17 00:00:00 2001
From: Christoph Helma <helma@in-silico.de>
Date: Tue, 15 Dec 2009 11:45:49 +0100
Subject: README updated

---
 README | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/README b/README
index 5a2c3a2..7dd464f 100644
--- a/README
+++ b/README
@@ -3,8 +3,34 @@ OpenTox model
 
 * An OpenTox REST Webservice (http://www.opentox.org)
 * Implements the OpenTox model API 
-* Ruby implementation of the lazar algorithm
+* Ruby implementation of lazar prediction models
 
-Documentation: Source code (application.rb, lazar.rb)
+REST operations:
+
+Get a list of all lazar models					GET			/			-							List of model URIs					200
+Get the representation of a lazar model	GET			/{id}	-							Model representation				200,404
+Predict a compound											POST		/{id}	compound_uri	Prediction representation		200,404,500
+Delete a model													DELETE	/{id}	-							-														200,404
+
+Supported MIME formats (http://chemical-mime.sourceforge.net/):
+
+  * application/rdf+xml (default): read/write OWL-DL
+  * application/x-yaml 
+
+Examples:
+
+List all lazar models
+	curl http://webservices.in-silico.ch/model
+
+Get the representation of a lazar model
+	curl -H "Accept:application/rdf+xml" http://webservices.in-silico.ch/model/{id}
+
+Predict a compound
+	curl -X POST -d compound_uri={compound_uri} http://webservices.in-silico.ch/model/{id}
+
+Delete a model
+	curl -X DELETE http://webservices.in-silico.ch/model/{id}
+
+More documentation: Source code (application.rb, lazar.rb)
 
 Copyright (c) 2009 Christoph Helma. See LICENSE for details.
-- 
cgit v1.2.3