Make the README more descriptive. - zs - Zeitungsschau rss to email converter
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
(DIR) commit e51ab5e0aa1bf500e4bf3c84d456eab162ebb4bd
(DIR) parent 2579767f2dc8a7ab9a2053187ad6f8fadf732b8d
(HTM) Author: Christoph Lohmann <20h@r-36.net>
Date: Sun, 10 May 2015 16:21:05 +0200
Make the README more descriptive.
Diffstat:
README.md | 30 +++++++++++++++++++++++-------
1 file changed, 23 insertions(+), 7 deletions(-)
---
(DIR) diff --git a/README.md b/README.md
@@ -2,13 +2,9 @@
## Build
- make install
+ ./setup.py
- or
-
- make PREFIX=/usr install
-
- or edit config.mk before install.
+ ./setup.py install
## Run
@@ -23,7 +19,27 @@
zs cfg smtppassword $password
zs cfg smtpssl True
-## Repetetive run for cron
+This does setup where the articles should be sent to.
+
+## Add some feed
+
+ zs add $URI
+
+## Remove some feed
+
+ zs del $URI
+
+## Tips for e-mail parsing
+
+Zeitungsschau will add following headers, which can be easily used for
+filtering to specific mailboxes:
+
+ X-RSS-URL (full URI of the article)
+ X-RSS-Feed (full URI of the feed)
+ X-RSS-ID (article ID)
+ X-RSS-TAGS (provided tags in the article or feed)
+
+## Repetitive run for cron
zs run >/dev/null