diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9081ff3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (C) 2011 by Marcel C. Morgan + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.rdoc b/README.rdoc index 747cdde..5223520 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,5 +1,35 @@ = Retort -rtorrent xmlrpc wrapper written in ruby (1.9). Designed to decouple the +rtorrent xmlrpc wrapper written in ruby (1.9). Designed to decouple the xmlrpc interface from the underlying ruby objects. +== Basic usage + +Update your Gemfile with this and do a bundle install: + + gem 'retort' + +To get a list of all torrents: + + require 'retort' + Retort::Torrent.all + +== Contributions + +To fetch & test the library for development, do: + + $ git clone https://github.com/mcmorgan/retort + $ cd retort + $ bundle + $ bundle exec rspec spec + +If you want to contribute, please: + + * 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. + * Send me a pull request on Github. + +== Copyright + +Copyright (c) 2010-2011 Marcel Morgan. See LICENSE for details.