feed-push: README annotate

annotate README @ 34:030e8b24f8b7 draft default tip master

pretty print JSON in state file Signed-off-by: Changaco <changaco ατ changaco δοτ net>

author	Changaco <changaco ατ changaco δοτ net>
date	Sun, 05 Aug 2012 15:18:28 +0200
parents	b960713823a7
children

rev	line source
1 a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	1 feed-push is a daemon that watches local RSS/Atom files for changes and executes commands when new articles appear.
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	2
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	3 It can replace scripts such as rss2email and rss2xmpp, using tools like sendmail and sendxmpp.py (http://changaco.net/code/sendxmpp-py).
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	4
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	5 Dependencies:
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	6 - gamin and its python2 bindings
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	7 - python2-feedparser
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	8
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	9 Compatibility: gamin only works on Linux and FreeBSD as of April 2012
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	10
3 0d4378996672 improve setup script Changaco <changaco ατ changaco δοτ net> parents: 1 diff changeset	11 Installation/Removal/Update: ./setup install\|uninstall\|update
1 a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	12
a68d7feeba88 initial commit Changaco <changaco ατ changaco δοτ net> parents: diff changeset	13 Configuration: see examples/
13 b960713823a7 add a note about globbing in README Changaco <changaco ατ changaco δοτ net> parents: 3 diff changeset	14 Note: globbing (i.e. using wildcards like in "*.atom") only works on startup, it won't detect files created after that.