diff README @ 1:a68d7feeba88 draft

initial commit Signed-off-by: Changaco <changaco ατ changaco δοτ net>
author Changaco <changaco ατ changaco δοτ net>
date Sun, 15 Apr 2012 18:05:20 +0200
parents
children 0d4378996672
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+feed-push is a daemon that watches local RSS/Atom files for changes and executes commands when new articles appear.
+
+It can replace scripts such as rss2email and rss2xmpp, using tools like sendmail and sendxmpp.py (http://changaco.net/code/sendxmpp-py).
+
+Dependencies:
+- gamin and its python2 bindings
+- python2-feedparser
+
+Compatibility: gamin only works on Linux and FreeBSD as of April 2012
+
+Installation: ./setup install
+Removal: ./setup uninstall
+
+Configuration: see examples/