Add readme

README.md

@@ -0,0 +1,21 @@
+pyircbot3
+=========
+**A modular python IRC bot**
+
+Quick start
+-----------
+
+* Install: `python3 setup.py install`
+* Configure: `cd examples ; vim config.yml data/config/Services.yml`
+* Run: `./run-example.sh` or `pyircbot -c config.yml`
+
+Developing Modules
+------------------
+
+Check docs/
+
+TODO
+----
+
+* Fix docs/
+* Add a way to pass additional directories where modules are stored

examples/config.yml

@@ -1,5 +1,5 @@
 bot:
-  datadir: /home/example/bot/data/
+  datadir: ./data/
   rpcbind: 0.0.0.0
   rpcport: 1876
 connection:
@@ -9,5 +9,3 @@ connection:
 modules:
   - PingResponder
   - Services
-  - MySQL
-  - AttributeStorage

examples/run-example.sh

@@ -1,2 +1,2 @@
 #!/bin/sh
-../bin/pyircbot --config config.instance.yml
+../bin/pyircbot --config config.yml