X-Git-Url: https://git.sommitrealweird.co.uk/rss2maildir.git/blobdiff_plain/63dc58ea5dc82d4ab0984101798fd8a813187450..c6030cecee302e61b7b1ada21676481c099728b4:/README?ds=inline

diff --git a/README b/README
index 74b04f4..3c45647 100644
--- a/README
+++ b/README
@@ -1,15 +1,29 @@
 rss2maildir
-=========
+===========
 
 Introduction
 ------------
 
 rss2maildir takes rss feeds and creates a maildir of messages for each of the
-feeds, new items become "new", updated entries also get marked as new when they
-are updated. Each feed becomes it's own maildir which can be named as you like.
+feeds, new items become "new", updated entries get redelivered as new messages.
+Each feed becomes it's own maildir which can be named as you like.
 
 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".
+