Adding notations to make it easier to navigate

README.md

@@ -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

config_default.py

@@ -1,29 +1,32 @@
-# The feeds, /!\ Put Atom feeds only
-feeds = {
-        'YIFY' : {
-            'url' : 'http://localhost/feedcleaner/?url=http://yify-torrents.com/rss',
-            'server' : 'pubsub.movim.eu'
-            },
-            
-        'LEquipe' : {
-            'url' : 'http://localhost/feedcleaner/?url=http://www.lequipe.fr/rss/actu_rss.xml',
-            'server' : 'sport.mov.im'
-            },
-        'SportingNews' : {
-            'url' : 'http://localhost/feedcleaner/?url=http://www.sportingnews.com/rss',
-            'server' : 'sport.mov.im'
-            },
+# Feed Settings
 
-        'OuestFrance' : {
-            'url' : 'http://localhost/feedcleaner/?url=http://www.ouest-france.fr/rss.xml',
-            'server' : 'news.mov.im'
+feeds = {
+        'FeedName1' : {                                                 # Change this to the name of the group you want to add this feed to
+            'url' : 'http://localhost/feedcleaner/?url=FEEDGOESHERE',   # Replace "FEEDGOESHERE" with the URL to the Atom Feed, leave the rest of of the line intact, see the example below
+            'server' : 'pubsubserver'                                   # Change this to the pubsub servername, including the TLD (eg. pubsub.domain.tld).  See the example below
+            },
+        # Add more feeds as you need them using this format
+        #'FeedName2' : {
+        #    'url' : 'http://localhost/feedcleaner/?url=FEEDGOESHERE',
+        #    'server' : 'pubsubserver'
+        #    },
+        # Remember to add a comma ',' after every close bracket except for the last one
+        'Feedname3' : {
+            'url' : 'http://localhost/feedcleaner/?url=http://feedurlhere/rss.xml',
+            'server' : 'pubsub.movim.eu'
             }
     }
 
-# XMPP 
-jid         = 'user@server.tld'
-resource    = 'atomtopubsub'
-secret      = 'password'
+# NB. Use Atom v0.3 feeds only
+
+# XMPP Authentication Settings
+
+jid         = 'user@server.tld' # XMPP UserID and domain to post the feeds as
+resource    = 'atomtopubsub'    # You can change this if you want, it only tells XMPP what application posted the feeds
+secret      = 'password'        # The password for the above UserID
 
 # Refresh intervals in minutes
-refresh_time = 15
+refresh_time = 60
+# The refresh time will be split evenly over all of your feeds.
+# Eg. 60 minutes across 3x feeds, will equal 1x feed will be refreshed every 20 minutes.
+# Or 60 minutes across 6x feeds would equal 1x feed will be refreshed every 10 minutes.