more methods fro feature/compound/retrieval, Rakefile with test and installation tasks

1 files changed, 44 insertions, 9 deletions

diff --git a/README b/README
index e015f63..c92506c 100644
--- a/README
+++ b/README
@@ -9,12 +9,47 @@ OpenTox Datasets
 
 * Implements a subset of the OpenTox dataset API (http://opentox.org/wiki/opentox/Dataset).
 
-* Requirements:
-
-	- Sinatra (http://www.sinatrarb.com/),
-	- sinatra-url-for (http://github.com/emk/sinatra-url-for/)
-	- RestClient (http://rest-client.heroku.com/)
-	- SQLite3 (www.sqlite.org/)
-	- Datamapper, dm-more (http://datamapper.org/)
-	- Builder (builder.rubyforge.org/)
-	- Rack::Test (http://github.com/brynary/rack-test/) for the tests
+REST API
+
+Description             	Method  URI                   									Parameters  		Result          			Status codes
+
+Get a list of all					GET			/																												List of URIs					200, 500
+datasets
+
+Get a XML representation	GET			/{id}																										XML representation		200, 404, 500
+of a dataset																																							of a dataset
+
+Get the dataset name			GET			/{id}/name																							Dataset name					200, 404, 500
+
+Get all compound URIs			GET			/{id}/compounds																					List of compound 			200, 404, 500
+from a dataset																																						URIs
+
+Get all feature URIs			GET			/{id}/features																					List of features			200, 404, 500
+
+Get all features with			GET			/{id}/features/compounds																XML with features 		200, 404, 500
+corresponding compounds																																		and compounds
+
+Get all compounds and			GET			/{id}/compounds/features																XML with compounds		200, 404, 500
+their features																																						and featues
+
+Get all features for a		GET			/{id}/compound/{compound_uri}/features									List of feature URIs	200, 404, 500
+compound URI
+
+Get all features for a		GET			/{id}/feature/{feature_uri}/compounds										List of compound URIs	200, 404, 500
+feature URI
+
+Create a new dataset			POST		/																				name						Dataset URI						200, 500
+
+Add a new association to	POST		/{id}																		compound_uri,		Dataset URI						200, 404, 500
+a dataset																																	feature_uri
+
+Delete a dataset					DELETE	/{id}																																					200, 404, 500
+
+Clear the content of a		DELETE	/{id}/associations																														200, 404, 500
+dataset
+
+INSTALLATION
+
+Run 'rake install' to install the required gems and openbabel
+
+Copyright (c) 2009 Christoph Helma. See LICENSE for details.