diff --git a/README.md b/README.md index 24079bb..f2b69e3 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,16 @@ pirate-get is a convenient command line tool (inspired by APT) to speed up your trip to the Pirate Bay and get your completely legal torrents more quickly. -Tested on Arch Linux mostly. It should work on any other Linux too. Let me know if it doesn't. -Also tested on OSX (works fine on yosemite) - -`--local` option hasn't been tested recently. - ## Installation -Make sure you have python 3 installed. -Requires `colorama` for colored output. +Make sure you have python 3 and pip installed. -Run `pip install pirate-get` or `pip3 install pirate-get` +Run `pip3 install pirate-get` ## Usage -To search use `pirate get [search term]`. +To search use `pirate-get [search term]`. -See `pirate-get -h` for help. +See `pirate-get -h` for more options. Watch [this](http://showterm.io/d6f7a0c2a5de1da9ea317) for an example usage. @@ -67,12 +61,11 @@ Note: Any command line option will override its respective setting in the config file. -## Notes +## Local Database If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently): http://thepiratebay.se/torrent/8156416 - ## License pirate-get is licensed under the GNU Affero General Public License version 3 or later. -See the accompanying file COPYING or http://www.gnu.org/licenses/agpl.html. +See the accompanying file LICENSE or http://www.gnu.org/licenses/agpl.html.