summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristoph Helma <helma@in-silico.ch>2011-03-11 14:28:46 +0100
committerChristoph Helma <helma@in-silico.ch>2011-03-11 14:28:46 +0100
commit974dc2e935a48e2091bf007b1a090ebfde09902d (patch)
tree685421f05c153564ac80026072f4989ad4c4275c
parent01b30f81d9154313eba834773b0e60bafa9b70eb (diff)
parenta8287d5b179801e0dbf765d28c9a92d755420415 (diff)
Merge branch 'release/v1.0.1' into development
-rw-r--r--.yardopts1
-rw-r--r--README52
-rw-r--r--README.md57
3 files changed, 58 insertions, 52 deletions
diff --git a/.yardopts b/.yardopts
new file mode 100644
index 0000000..c1a7ad0
--- /dev/null
+++ b/.yardopts
@@ -0,0 +1 @@
+application.rb
diff --git a/README b/README
deleted file mode 100644
index 9360ef0..0000000
--- a/README
+++ /dev/null
@@ -1,52 +0,0 @@
-OpenTox Compound
-================
-
-* An OpenTox REST Webservice (http://www.opentox.org)
-* Implements the OpenTox compound API 1.1 (http://opentox.org/dev/apis/api-1.1/structure)
-
-REST operations
----------------
-
-Get the representation of a compound GET /compound/{id} - Compound representation 200,404,500
-Create a new compound POST /compound Compound representation URIs for new compounds 200,400,500
-
-Supported MIME formats (http://chemical-mime.sourceforge.net/)
---------------------------------------------------------------
-
- * chemical/x-daylight-smiles (default)
- * chemical/x-inchi
- * chemical/x-mdl-sdfile
- * text/plain (chemical names)
- * image/gif (returns image uri, output only)
-
-Examples
---------
-
- Create a compound_uri from smiles:
- curl -X POST -H "Content-Type:chemical/x-daylight-smiles" --data-binary "c1ccccc1" http://webservices.in-silico.ch/compound
-
- Create a compound_uri from a SD file:
- curl -X POST -H "Content-Type:chemical/x-mdl-sdfile" --data-binary @my.sdf http://webservices.in-silico.ch/compound
-
- Create a compound_uri from name (or any other identifier that can be resolved with the Cactus service):
- curl -X POST -H "Content-Type:text/plain" --data-binary "Benzene" http://webservices.in-silico.ch/compound
-
- Create a compound_uri from CAS:
- curl -X POST -H "Content-Type:text/plain" --data-binary "71-43-2" http://webservices.in-silico.ch/compound
-
- Get SMILES for a compound_uri:
- curl http://webservices.in-silico.ch/compound/InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H
-
- Get a SD file for a compound_uri:
- curl -H "Accept:chemical/x-mdl-sdfile" http://webservices.in-silico.ch/compound/InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H
-
- Get all names for a compound_uri:
- curl -H "Accept:text/plain" http://webservices.in-silico.ch/compound/InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H
-
-API documentation
------------------
-
-http://rdoc.info/github/opentox/compound
-
-Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85f177b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+epenTox Compound
+================
+
+- An [OpenTox](http://www.opentox.org) REST Webservice
+- Implements the [OpenTox compound API 1.2](http://opentox.org/dev/apis/api-1.2/structure)
+
+REST operations
+---------------
+
+ Get the representation of a compound GET /compound/{id} - Compound representation 200,404,500
+ Create a new compound POST /compound Compound representation URIs for new compounds 200,400,500
+
+Supported MIME formats (http://chemical-mime.sourceforge.net/)[http://chemical-mime.sourceforge.net/]
+--------------------------------------------------------------
+
+- chemical/x-daylight-smiles (default)
+- chemical/x-inchi
+- chemical/x-mdl-sdfile
+- text/plain (chemical names)
+- image/gif (returns image uri, output only)
+
+Examples
+--------
+
+### Create a compound_uri from smiles
+
+ curl -X POST -H "Content-Type:chemical/x-daylight-smiles" --data-binary "c1ccccc1" http://webservices.in-silico.ch/compound
+
+### Create a compound_uri from a SD file
+
+ curl -X POST -H "Content-Type:chemical/x-mdl-sdfile" --data-binary @my.sdf http://webservices.in-silico.ch/compound
+
+### Create a compound_uri from name (or any other identifier that can be resolved with the Cactus service)
+
+ curl -X POST -H "Content-Type:text/plain" --data-binary "Benzene" http://webservices.in-silico.ch/compound
+
+### Create a compound_uri from CAS
+
+ curl -X POST -H "Content-Type:text/plain" --data-binary "71-43-2" http://webservices.in-silico.ch/compound
+
+### Get SMILES for a compound_uri
+
+ curl http://webservices.in-silico.ch/compound/InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H
+
+### Get a SD file for a compound_uri:
+
+ curl -H "Accept:chemical/x-mdl-sdfile" http://webservices.in-silico.ch/compound/InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H
+
+### Get all names for a compound_uri
+
+ curl -H "Accept:text/plain" http://webservices.in-silico.ch/compound/InChI=1S/C6H6/c1-2-4-6-5-3-1/h1-6H
+
+[API documentation](http://rdoc.info/github/opentox/compound)
+-------------------------------------------------------------
+
+Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details.
+