README.md in nnmClub_api-0.1.0 vs README.md in nnmClub_api-0.1.1
- old
+ new
@@ -16,15 +16,34 @@
$ gem install nnmClub_api
## Usage
- require 'nnmClub_api'
+ require 'nnmClub_api'
+
+### Example:Search
- client = NnmclubApi.new
- client.search(:title => "Noize MC")
+ NnmClub::Search("Noize MC").torrents
- puts client.result
+returns an Array of Hashes
+
+ { :title => the title of the distribution,
+ :size => size,
+ :seeders => seeders,
+ :leechers => leechers,
+ :torrent_id => torrent_id,
+ :tracker => NnmClub::ID
+ }
+
+### Example:Torrent
+
+ NnmClub::Torrent.find "728159"
+
+returns an Hash
+
+ { :content => "HTML"
+ :image => "UTL"
+
## Contributing
1. Fork it ( https://github.com/gemoroy/nnmClub_api/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)