Compare commits

..

No commits in common. "patch-2" and "master" have entirely different histories.

View File

@ -1,20 +1,28 @@
## About AtomToPubsub
== About ==
AtomToPubsub is a simple Python script that parses Atom feeds and pushes
the entries to a designated [XMPP Pubsub Node](http://xmpp.org/extensions/xep-0060.html)
AtomToPubsub is a simple Python software that parse Atom feeds and push
the entries on a XMPP Pubsub Node (http://xmpp.org/extensions/xep-0060.html)
## Requirements
== Installation ==
* Python
* GIT Core
* PIP
* feedparser
* jsonpickle
* sleekxmpp
* screen
AtomToPubsub is built using Python 2.6 and use the librairies :
- feedparser
- time
- pickle
- sleekxmpp (version > 1.0, you can download and install it from here http://sleekxmpp.com/)
- sys
AtomToPubsub is built using Python 2.6 and use the librairies
== Configuration ==
## Installation
Rename config_default.py to config.py and set your Atom feeds and your
XMPP account configuration.
Please see the [Wiki](https://github.com/edhelas/atomtopubsub/wiki) for more information.
The XMPP account must be authorized to create Pubsub node on the server(s).
== Features ==
- The "key" of each feed of the configuration file will be the name of
the Pubsub node
- AtomToPubsub will try to fill the title and the description of the
Pubsub node from the title and the subtitle of the Atom node
- A cache file is created for performance issues