Commits

Laurent Bachelier  committed 1b065f6

Better README

  • Participants
  • Parent commits bdc88f4

Comments (0)

Files changed (1)

-# rtorrent-notify
+===============
+rtorrent-notify
+===============
 
+Description
+-----------
 
-## Setup
+rtorrent-notify aims to be a very simple tool to notify users of rtorrent-related events.
+It can actually be used for other kind of events, being 
+
+Upgrading
+---------
+
+Pickle is picky about code updates, so you often have to delete the event database.
+
+Setup
+-----
 
 Install PyRSS2Gen.
 
 Note: you can also edit the additem.py file.
 
 
-Add this to your .rtorrent.rc:
+Add this to your .rtorrent.rc::
 
-    system.method.set_key = event.download.finished,rt2rss_finished,"execute=~/rtorrent2rss/additem.py,FINISH,$d.get_base_path="
-    system.method.set_key = event.download.inserted_new,rt2rss_inserted,"execute=~/rtorrent2rss/additem.py,INSERT,$d.get_name="
+    system.method.set_key = event.download.finished,rtnfy_finished,"execute=~/rtorrent2rss/additem.py,FINISH,$d.get_base_path="
+    system.method.set_key = event.download.inserted_new,rtnfy_inserted,"execute=~/rtorrent2rss/additem.py,INSERT,$d.get_name="
 
-For older versions of rtorrent (pre 0.8.4):
+For older versions of rtorrent (pre 0.8.4)::
 
-    on_finished = rt2rss_finished,"execute=~/rtorrent2rss/additem.py,FINISH,$d.get_base_path="
-    on_start = rt2rss_started,"execute=~/rtorrent2rss/additem.py,START,$d.get_name="
+    on_finished = rtnfy_finished,"execute=~/rtorrent2rss/additem.py,FINISH,$d.get_base_path="
+    on_start = rtnfy_started,"execute=~/rtorrent2rss/additem.py,START,$d.get_name="
 
 
-Yes, it is that unreadable. "FINISH" and "START" are just strings, you can change them.
+Yes, it is that unreadable. ``FINISH`` and ``START`` are just strings, you can change them.
 
 Some tips:
-* There are other events you might be interested in. As there is no documentation, you can try to grep for ``event.`` in rtorrent's source code.
-* get_base_path doesn't work with the "inserted" event, you can use get_name instead.
-* You will find a list of properties to use in ui/download.cc
-
+- There are other events you might be interested in. As there is no documentation, you can try to grep for ``event.`` in rtorrent's source code.
+- get_base_path doesn't work with the "inserted" event, you can use get_name instead.
+- You will find a list of properties to use in ui/download.cc
 
-## Future features
+Future features
+---------------
 
 Allow to set a path for the event database and the RSS output on command line.