# HG changeset patch
# User Myhailo Danylenko <isbear@ukrpost.net>
# Date 1345380194 -10800
# Node ID 4b9d1a7e68613e7e1ec7194817d1b1364f966b64
# Parent  ef69edc792be8a133fca11f0e0caac50ab690f95
Update docs

diff -r ef69edc792be -r 4b9d1a7e6861 docs/readme.mdwn
--- a/docs/readme.mdwn	Sun Aug 19 15:28:43 2012 +0300
+++ b/docs/readme.mdwn	Sun Aug 19 15:43:14 2012 +0300
@@ -1,50 +1,60 @@
 
-This is a lua 5.1 interface for loudmouth jabber client library.
+# Loudmouth interface for lua
+
+This interface to loudmouth XMPP client library for lua 5.1.
+
+Main loudmouth project is now unmaintained, but mcabber community keeps
+working version with some improvements at
+<http://github.com/mcabber/loudmouth>.
 
-INSTALLATION
+Test script depends on my glib module, and thus is unusable as is.
+Still, it is a good example of how things are working.
+
+This module should be used as follows:
+lm = require 'lm'
+i.e., you should assign return value of *require* to some variable.
+
+Loudmouth uses glib main loop to work, thus you should use this module 
+in a glib loop environment, provided either by your glib-based program
+or by some other module, eg lua binding for gtk+ or my glib module.
+
+# Installation
 
 To install it, you need:
-- lua (optional, to run test)
-- liblua headers and library
-- glib headers and library
-- loudmouth headers and library
-- cmake
-- pkg-config (to detect glib and loudmouth)
-- perl (optional, to generate documentation)
+
+ * lua (optional, to run test)
+ * liblua headers and library
+ * glib headers and library
+ * loudmouth headers and library
+ * cmake
+ * c compiler (gcc)
+ * linker (binutils)
+ * pkg-config (to detect glib and loudmouth)
+ * perl (optional, to generate documentation)
 
-Then do
-$ mkdir build
-$ cd build
-$ cmake ..
-$ cmake edit_cache
-$ make
-# make install
+Then do: 
 
-Debian users can instead of make install do,
-$ fakeroot make package
-# dpkg -i liblua5.1-*.deb
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ cmake edit_cache
+    $ make
+    # make install
+
+Debian users can instead of make install do:
+
+    $ make package
+    # dpkg -i liblua5.1-loudmouth_*.deb
 
 Users of other systems can set other CPack generator using cache editor.
 
-NOTES
-
-Unfortunately, test script depends on my unfinished (and, probably, never finished)
-glib module, and thus is unusable as is.
-
-This module should be used as follows:
-lm = require 'lm'
-i.e., you should assign require return value to some variable.
+# License
 
-Loudmouth uses glib main loop to work, thus you should use this module in
-a glib loop environment, provided either by your glib-based program or by some
-other module, eg lua binding for gtk+.
+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/>.
 
-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
+# Contact
 
 I will be happy to get feedback, patches, suggestions, etc.
 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
diff -r ef69edc792be -r 4b9d1a7e6861 docs/todo.mdwn
--- a/docs/todo.mdwn	Sun Aug 19 15:28:43 2012 +0300
+++ b/docs/todo.mdwn	Sun Aug 19 15:43:14 2012 +0300
@@ -1,11 +1,13 @@
 
-Verify refcounts of lm objects. Need a decent test script for that.
-Some additional lua functions?
-Do something about strcasecmp non-portability.
-Add versions to dependencies.
-Finish parse function?
-Do something about debug and logging.
+* module
+  * Verify refcounts of lm objects. Need a decent test script for that.
+  * Some additional lua functions?
+  * Do something about strcasecmp non-portability.
+  * Add versions to dependencies.
+  * Finish parse function?
+  * Do something about debug and logging.
+* loudmouth
+  * Get child value method
+  * Xml console interception means?
+  * Attribute list retrieval method
 
-Get child value method
-Xml console interception means?
-