X-Git-Url: https://git.sommitrealweird.co.uk/rss2maildir.git/blobdiff_plain/000dee14c3e9109f4bce5f11d108fdd6b760c423..286e096cd216854c5a9bc8cdc580e5d3ec447f19:/README

diff --git a/README b/README
index f151bc9..3c45647 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 rss2maildir
-=========
+===========
 
 Introduction
 ------------
@@ -13,3 +13,17 @@ Usage
 
 Create a config file containing the feeds and their "names" - the names will be
 used as the directory name of the maildir for the feed.
+
+Config File Format
+------------------
+
+  [general]
+  state_dir = "/path/to/a/writtable/directory/to/write/state/to"
+  maildir_root = "/path/to/directory/to/write/maildirs/in"
+
+  [http://path/to/a/rss/feed/]
+  maildir = "name of folder to put mail in"
+
+The state_dir in the general section defaults to the current working directory + state.
+The maildir_root defaults to the current working directory + "RSSMaildir".
+