summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYves Fischer <yvesf-git@xapek.org>2015-11-22 01:57:34 +0100
committerYves Fischer <yvesf-git@xapek.org>2015-11-22 01:58:50 +0100
commit8a09780ea60fe4a67a5e8fdac23156da7d0814a3 (patch)
tree2351462b1ded93f6dc75fba811fc50884f289ea7 /README.md
parent8e8572780c2b371cbec706de8fb5e38070825a3e (diff)
downloadwatchnews-8a09780ea60fe4a67a5e8fdac23156da7d0814a3.tar.gz
watchnews-8a09780ea60fe4a67a5e8fdac23156da7d0814a3.zip
readme: install
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1d93fd9..8874437 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,9 @@ Aggregate RSS and archive website for later diffing.
# USAGE
- usage: watchnews.py [-h] [--add URL] [--update] [--update-feed ID]
- [--remove ID] [--list] [--web]
+ ./watchnews-cli --help
+ usage: watchnews-cli [-h] [--add URL] [--update] [--update-feed ID]
+ [--remove ID] [--list] [--web] [--db DBPATH] [--rss]
Process some integers.
@@ -19,7 +20,8 @@ Aggregate RSS and archive website for later diffing.
--remove ID Remove feed with ID
--list List all registered feeds
--web Run web interface
-
+ --db DBPATH Path to sqlite database file
+ --rss Dump a RSS feeds
## Example
@@ -27,3 +29,10 @@ Aggregate RSS and archive website for later diffing.
./watchnews.py --update
./watchnews.py --web
+# Installing
+
+One way to install it is to use pip:
+ pip3 install --upgrade --user https://www.xapek.org/git/yvesf/watchnews/archive/master.zip
+
+On debian this requires at least:
+ python3-dev build-essential libxslt1-dev zlib1g-dev