README
changeset 29 23fa36d480fb
parent 18 fbe6977b37cc
child 37 0477d4800fbd
--- a/README	Wed Jun 29 19:25:16 2011 +0300
+++ b/README	Sun May 20 22:15:51 2012 +0300
@@ -1,11 +1,41 @@
 
-This is a pep module for mcabber. It just provides common message
-listener for other modules like tune, avatar etc.
+# Personal Eventing Protocol modules
+
+This is a set of modules, that provide notfication about other's events
+and allow you to publish yours.
+
+Pep module provides common listener for incoming PEP events.
+
+Tune module provides '/tune' command to publish music, you are listening
+to at the moment. However, it does not by itself does that. You'll need
+some other module, that will provide music information, like 'mpd' one.
+Alternatively, you can set up some scripts to publish information with
+'/tune' command via fifo.
+
+Mood module provides '/mood' command to publish your current mood.
+Currently it does not check for validity of its input, so, it's strongly
+suggested to use provided completion for first argument.
 
-This module have no options, and generally should be loaded
-automatically by other modules.
+Geoloc module provides '/geoloc' command to publish your current location.
+Currently, there are no known use cases of this module, but I hope, that
+someday there will be a module, that will retrieve geolocation information
+from devices and use this module to publish it.
+
+Activity module provides '/activity' command to publish your current activity.
+Currently it does not check for validity of its input either, so, please
+use completion for first two arguments.
 
-INSTALLATION
+Note: In order for you to actually publish something, your server must
+support PEP, and that is still not that widely available. Still, even
+if your server does not, you can load modules to be notified about your
+buddies events.
+
+All of the modules also provide C headers for other C modules to use
+to publish data. Note, however, that I plan to switch to events interface
+for that - it provides multiplexing ability, and in general is more
+flexible.
+
+# Installation
 
 To install it, you need:
 cmake
@@ -30,16 +60,15 @@
 Users of other distributions can select appropriate package
 generator, using cache editor.
 
-LICENSE
+# License
 
 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
 
-CONTACTS
+# Contacts
 
 I will be happy to get feedback, patches, suggestions, etc.
 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
 
   -- Myhailo Danylenko <isbear@ukrpost.net>
 
-