diff -r f23b9521b4d6 -r 0477d4800fbd docs/readme.mdwn
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Mon Aug 20 18:53:05 2012 +0300
@@ -0,0 +1,85 @@
+
+# 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.
+[[List of valid moods|moods]]
+
+'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.
+[[List of valid activities|activities]]
+
+Modules recognize options 'tune_interval' and 'geoloc_interval' to
+limit publication rate and option 'tune_pause_is_stop', that controls
+whether tune should publish empty information for paused state.
+
+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:
+
+ * mcabber headers
+ * glib
+ * loudmouth
+ * cmake
+ * make
+ * c compiler (gcc)
+ * linker (binutils)
+
+Then do:
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make edit_cache
+    $ make
+    # make install
+
+Debian users can instead of make install do:
+
+    $ make package
+    # dpkg -i libmcabber-pep_*.deb
+
+Users of other distributions can select appropriate package generator,
+using cache editor.
+
+# 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/>.
+
+# Contact
+
+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>
+