diff options
Diffstat (limited to 'README.rdoc')
| -rw-r--r-- | README.rdoc | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/README.rdoc b/README.rdoc index 4b593d1..f33ef93 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,17 +1,22 @@ = opentox-ruby-api-wrapper -Description goes here. - -== Note on Patches/Pull Requests - -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but - bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. +Ruby wrapper for the OpenTox REST API (http://www.opentox.org) + +== Installation + +Run the following if you haven't already: + + gem sources -a http://gems.github.com + +Install the gem: + + sudo gem install helma-opentox-ruby-api-wrapper + +== Usage + +- set the environment variables OPENTOX_COMPOUNDS, OPENTOX_FEATURES, OPENTOX_DATASETS, OPENTOX_FMINER to the base URI of the OpenTox REST webservices +- require 'opentox-ruby-api-wrapper' in your ruby application +- consult the API documentation for details == Copyright |