README

   1 rss2maildir
   2 ===========
   3
   4 Introduction
   5 ------------
   6
   7 rss2maildir takes rss feeds and creates a maildir of messages for each of the
   8 feeds, new items become "new", updated entries get redelivered as new messages.
   9 Each feed becomes it's own maildir which can be named as you like.
  10
  11 Usage
  12 -----
  13
  14 Create a config file containing the feeds and their "names" - the names will be
  15 used as the directory name of the maildir for the feed.
  16
  17 Config File Format
  18 ------------------
  19
  20   [general]
  21   state_dir = "/path/to/a/writtable/directory/to/write/state/to"
  22   maildir_root = "/path/to/directory/to/write/maildirs/in"
  23
  24   [http://path/to/a/rss/feed/]
  25   maildir = "name of folder to put mail in"
  26
  27 The state_dir in the general section defaults to the current working directory + state.
  28 The maildir_root defaults to the current working directory + "RSSMaildir".
  29