diff -r 4bf7ef2fea2e -r ef69edc792be docs/readme.mdwn
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Sun Aug 19 15:28:43 2012 +0300
@@ -0,0 +1,53 @@
+
+This is a lua 5.1 interface for loudmouth jabber client library.
+
+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)
+
+Then do
+$ mkdir build
+$ cd build
+$ cmake ..
+$ cmake edit_cache
+$ make
+# make install
+
+Debian users can instead of make install do,
+$ fakeroot make package
+# dpkg -i liblua5.1-*.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.
+
+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+.
+
+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
+
+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>
+