Updated to include Wiki

README.md

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