diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..70760ae --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +opentox-client +==================== + +Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. + +Libraries: + +* {OpenTox::Algorithm} Wrapper for OpenTox Algorithms +* {OpenTox::Authorization} Authorization and Authentication +* {OpenTox::Compound} Compound Library +* {OpenTox::Dataset} Dataset Library +* {OpenTox::Error} extends Exception class according the OpenTox API +* {OpenTox::Model} Model Library +* {OpenTox} OpenTox Library - general definition of OpenTox objects +* {OTLogger} OpenTox Logger Extensions +* {OpenTox::Policies} parse and serialize XML for the openSSO A&A server +* {OpenTox::RestClientWrapper} wrapper for the RestClient gem +* {OpenTox::Task} Task Library + + +Dependencies +------------ + + libraptor1-dev + +Installation +------------ + + gem install opentox-client + +Documentation +------------- +* [API documentation](http://rdoc.info/gems/opentox-client) +* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-client/development/frames) + +Copyright +--------- +Copyright (c) 2009-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. |