summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYves Fischer <yvesf-git@xapek.org>2015-11-21 13:27:51 +0100
committerYves Fischer <yvesf-git@xapek.org>2015-11-21 13:37:05 +0100
commit76b682ac3073638fda5d6caa23594dd56bf6f06d (patch)
tree0b398cf3f8ea9f95e6b9727bfb8bc639c9dc8376 /README.md
downloadwatchnews-76b682ac3073638fda5d6caa23594dd56bf6f06d.tar.gz
watchnews-76b682ac3073638fda5d6caa23594dd56bf6f06d.zip
a functional draft
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d93fd9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Watchnews
+
+Aggregate RSS and archive website for later diffing.
+
+
+
+# USAGE
+
+ usage: watchnews.py [-h] [--add URL] [--update] [--update-feed ID]
+ [--remove ID] [--list] [--web]
+
+ Process some integers.
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --add URL add feed with URL
+ --update Update all known feeds
+ --update-feed ID Update feed with ID
+ --remove ID Remove feed with ID
+ --list List all registered feeds
+ --web Run web interface
+
+
+## Example
+
+ ./watchnews.py --add 'http://blog.fefe.de/rss.xml?html'
+ ./watchnews.py --update
+ ./watchnews.py --web
+