Fixes #4 - Very basic configuration docs

README.md

@@ -1,12 +1,11 @@
-pirate-get
----
+# pirate-get
 
 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 (whatever the latest one is - I don't know; I don't use non-free operating systems.) --local option hasn't been tested recently.
 
-Installation
----
+
+## Installation
 
 Make sure you have python 2 installed.
 
@@ -15,8 +14,7 @@ Run install.sh
 If you're using Arch Linux there's a package avalaible at the AUR:
 https://aur.archlinux.org/packages/pirate-get-git/
 
-Usage
----
+## Usage
 
 ```
 usage: pirate-get.py [-h] [-t] [--custom COMMAND] [--local DATABASE]
@@ -38,6 +36,24 @@ optional arguments:
   --color           use colored output
 ```
 
+## Configuration file
+
+pirate-get will check to see if `$HOME/.config/pirate-get/pirate.cfg` exists. If it does it will use it as its default configuration settings.
+
+### SaveToFile
+
+**Currently this is the only way to save magnet urls to a file**
+
+A config file would look something like:
+
+```INI
+[SaveToFile]
+enabled = true
+directory = ~/Dropbox/pirate-get/
+```
+
+## Notes
+
 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