* Add https support (thanks to Andre Klärner)

[rss2maildir.git] / README

diff --git a/README b/README
index f151bc9e0c6349b26d84189311823bd958d5dd46..3c45647370f044384705bbae46c7ace0a7463a26 100644 (file)
--- 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".
+