aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.org8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.org b/README.org
index b9dba73..c091bf1 100644
--- a/README.org
+++ b/README.org
@@ -1,7 +1,7 @@
1# LocalWords: asyncio async plugin 1# LocalWords: asyncio async plugin
2 2
3* Setting up the bot 3* Setting up the bot
4D'bolla is a no bullshit extensible IRC/Slack bot written for Python 3.5 using 4Warmachine is a no bullshit extensible IRC/Slack bot written for Python 3.5 using
5asyncio. 5asyncio.
6 6
7** Install dependencies: 7** Install dependencies:
@@ -11,7 +11,7 @@ asyncio.
11#+END_SRC 11#+END_SRC
12 12
13** Configure 13** Configure
14Copy dbolla.conf.example to dbolla.conf and edit this file. You can 14Copy warmachine.conf.example to warmachine.conf and edit this file. You can
15specify multiples of the same connection by prefixing the config section with 15specify multiples of the same connection by prefixing the config section with
16'slack:' or 'irc:' followed by a unique name for this connection. 16'slack:' or 'irc:' followed by a unique name for this connection.
17 17
@@ -19,7 +19,7 @@ specify multiples of the same connection by prefixing the config section with
19Simply run the command: 19Simply run the command:
20 20
21#+BEGIN_SRC bash 21#+BEGIN_SRC bash
22 ./bin/dbolla -c /path/to/my/dbolla.conf 22 ./bin/warmachine -c /path/to/my/warmachine.conf
23#+END_SRC 23#+END_SRC
24 24
25* Writing a Plugin 25* Writing a Plugin
@@ -87,7 +87,7 @@ defined somewhere near the top of your file.
87** ~self.config_dir~ 87** ~self.config_dir~
88The directory to store any configuration files and other junk in. 88The directory to store any configuration files and other junk in.
89** ~self.connect()~ 89** ~self.connect()~
90D'bolla uses python 3's asyncio to manage multiple connections concurrently thus 90Warmachine uses python 3's asyncio to manage multiple connections concurrently thus
91you should use ~asyncio.open_connection~ to create your connection. Once you 91you should use ~asyncio.open_connection~ to create your connection. Once you
92have successfully connected you must set ~self.status~ to 92have successfully connected you must set ~self.status~ to
93~warmachine.connections.base.CONNECTED~. This indicates the connection is ready 93~warmachine.connections.base.CONNECTED~. This indicates the connection is ready