Skip to content

Commit

Permalink
Update README and add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelmorgan committed Sep 11, 2011
1 parent 8fd71bf commit ebb265b
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 1 deletion.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
32 changes: 31 additions & 1 deletion README.rdoc
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit ebb265b

Please sign in to comment.