From: Christian Weiske <cweiske@cweiske.de>
Date: Mon, 9 May 2016 20:10:45 +0000 (+0200)
Subject: more readme
X-Git-Url: https://git.cweiske.de/errbot-exec.git/commitdiff_plain/da12b759a02d51c44fbb16cb0376cbee89a61b57

more readme
---

diff --git a/.gitignore b/.gitignore
index d3c4e47..c93664b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 *.pyc
 /tmp/
 /config.py
+/README.html
diff --git a/README.rst b/README.rst
index 0d55904..e652833 100644
--- a/README.rst
+++ b/README.rst
@@ -1,14 +1,32 @@
-**********************
-Exec plugin for errbot
-**********************
+**************************
+Exec plugin for `errbot`__
+**************************
+
+__ http://errbot.io/
 
 Execute an external command when the bot is talked to.
 
+I wrote it so I can write bots in PHP, while letting `errbot`__ do
+all the connection handling and stuff.
+
+The executed script gets the message as first, and the username
+sending the message as second parameter.
+
+__ http://errbot.io/
+
 =============
 Configuration
 =============
 In ``config.py``::
 
     EXEC = {
-        'command': u'echo'
+        'command': 'echo'
+    }
+
+Useful default errbot config settings:
+
+- Only allow some users to talk to the bot::
+
+    ACCESS_CONTROLS_DEFAULT = {
+        'allowusers': ('gbin@localhost', 'user@example.org'),
     }