diff --git a/README.md b/README.md index 2e4bbd3..1054d08 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,39 @@ -# Newsletter 2 Web +# Newsletter to Web -Converts a newsletter to static HTML files. +Converts a newsletter to and Atom feed and static HTML files. + +## Usage + +### Getting help + +For help, use + +* `newsletter-to-web help` +* `newsletter-to-web help `. + +### Basic usage + +First, download all messages from the IMAP mail server +and store them in the `data/` directory: + +```sh +newsletter-to-web fetch-from-imap -s -u -p +``` + +Then, convert them to an Atom feed, using +`newsletters.example.com` as the base domain: + +```sh +newsletter-to-web --include-html build-feed newsletters.example.org +``` + +This will put the output in the `output/` directory. The Atom +feed will be in `output/feed.xml`, together with a very simple +`index.html` file pointing to the feed. It will also add an HTML +file for every email with the HTML content. + +The feed will already contain the full HTML, so it can easily be +read from a feed reader. ## Features