# HG changeset patch
# User Myhailo Danylenko <isbear@ukrpost.net>
# Date 1345219748 -10800
# Node ID 5d86c5fefef655f3339ddecc872adafc1061c5d8
# Parent  4e171209caee5fcd6efa1d0afa55d8135fe031b6
Update readme

diff -r 4e171209caee -r 5d86c5fefef6 docs/readme.mdwn
--- a/docs/readme.mdwn	Fri Aug 17 18:51:32 2012 +0300
+++ b/docs/readme.mdwn	Fri Aug 17 19:09:08 2012 +0300
@@ -1,10 +1,37 @@
 
 # Welcome to Yet Another Yuseless Built-In Language!
 
-It provides conditional and command grouping expressions,
-as well as some arithmetic expression evaluation and string
-concatenation. String splitting is not yet implemented,
-but is planned.
+This module provides next commands:
+
+ * 'multi' allows to execute several mcabber commands at once.
+   Handy for bindings, aliases, hooks and other. Use semicolons
+   to separate commands (note, however, that commands itself cannot
+   contain semicolon).
+ * 'if', 'then' and 'else' provide crude conditional construction.
+   'if' evaluates given expression (see 'eval' for rules) and stores
+   result. After that, 'then' and 'else' can be executed as many times,
+   as you need, they will use stored value.
+ * 'let' works like 'set', but assigned value is evaluated first
+   (see 'eval' for rules).
+ * 'eval' evaluates expression and then executes it as mcabber command.
+   Expression can contain unquoted variable names, double-quoted strings,
+   numbers and next operators:
+
+    * . string concatenation
+    * : string head
+    * \^ string tail
+    * + binary plus / string concatenation
+    * - binary minus
+    * \* multiplication / string replication
+    * / division
+    * % division remain
+    * \< binary / string less than
+    * \> binary / string greater than
+    * = binary / string equality
+
+   All operators have the same priority, and there is no grouping.
+
+All commands are marked as safe to use in initial config file.
 
 # Installation
 
@@ -27,8 +54,8 @@
 
 Debian users can instead of make install do
 
-    $ fakeroot make package
-    # dpkg -i libmcbber-yaubil*.deb
+    $ make package
+    # dpkg -i libmcabber-yaubil*.deb
 
 Users of other distributions can select appropriate package
 generator, using cache editor.