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

[rss2maildir.git] / README

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