--- a/docs/readme.mdwn Wed Nov 28 04:27:33 2012 +0200
+++ b/docs/readme.mdwn Wed Nov 28 18:38:52 2012 +0200
@@ -1,15 +1,21 @@
# Lua scripting for MCabber
-This module creates lua interpreter environment and puts some lua
-functions in it to interact with mcabber. Module provides command 'lua'
-to run lua expressions in that environment.
+This module creates lua 5.1 or 5.2 interpreter environment and puts some lua
+functions inside for your code to interact with mcabber.
+
+Module provides mcabber command `/lua5.1` or `/lua5.2` respectively and adds
+an alias `/lua` for that command. This command evaluates argument as lua code in
+created by module environment.
-Lua interface is available in api reference, built with 'docgen' help.
-It is also available online.
+Note: If you load both versions - `lua5.1` and `lua5.2`, alias will point to
+which was loaded last.
-In 'examples' dir there are some example scripts, that may be used as
-is or for reference. See also 'README' in 'examples' dir.
+Lua functions, available in environment are described in api reference, built
+with `docgen` help. It is also available online.
+
+In `examples` dir there are some example scripts, that may be used as is or for
+reference. See also `README` in `examples` dir.
# Installation
@@ -37,11 +43,20 @@
Debian users can instead of make install do:
$ make package
- # dpkg -i libmcabber-lua_*.deb
+ # dpkg -i mcabber-mod-lua5.?_*.deb
Users of other distributions can select appropriate package generator,
using cache editor.
+# Building options
+
+Through `make edit_cache` action you can adjust module parameters. Notably: if
+you set `WANT_LUA52`, module will be built against lua5.2, even if lua5.1 is
+present; you can disable aliasing `lua` command at module loading time by
+unsetting `ENABLE_LUA_ALIAS`; you can adjust mcabber option names to be
+version-specific, if you need both versions running simultaneously via
+`OPT_MLUA_RC` and `OPT_MLUA_DEBUG`.
+
# License
This code underlies terms of GNU GPL v2 or later. You can find it in