Skip to content

Latest commit

 

History

History
41 lines (22 loc) · 1.82 KB

README.md

File metadata and controls

41 lines (22 loc) · 1.82 KB

Build Status Dependency Status Inline docs

Maintainability Test Coverage

Torznab::Client

Ruby client for Torznab APIs. (like Jackett)

Installation

Add this line to your application's Gemfile:

gem 'torznab-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install torznab-client

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Nicolas MERELLI/torznab-client.

License

The gem is available as open source under the terms of the MIT License.