README.md in nyaa-0.1.2 vs README.md in nyaa-0.3.0
- old
+ new
@@ -1,13 +1,39 @@
-# nyaa
+# Nyaa
Nyaa is a CLI to NyaaTorrents. You can browse, search, and download. Nifty.
## Installation
gem install nyaa
## Usage
+To start browsing immediately, simply run `nyaa`. The default category is english anime.
+
+
+
+Nyaa supports all the aspects of search of the main site. You can search by category and/or filters. Nyaa also shows a summary of seeders, leechers, total filesize, and number of downloads. To download an item, simply enter the number of the result.
+
+ nyaa -c anime_english -f trusted_only 'guilty crown'
+
+
+
+For a list of categories and filters, see `nyaa -h`.
+
+
+
+## Contributing
+0. See HACKING file for style guidelines
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
## License
-See LICENSE
+See LICENSE file.
+
+## Authors
+
+See AUTHORS file.