aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Phillips <david@sighup.nz>2017-03-17 16:31:41 +1300
committerDavid Phillips <david@sighup.nz>2017-03-17 16:31:41 +1300
commit111ce32be63cb17789d9bea89a689338776e670c (patch)
treeeff8cac8ce440240d094617b33a4e1b142b16fd1 /README.md
parentcc613822bf78d1a73e02bc3ddf99bea68babe3ad (diff)
downloadidalius-111ce32be63cb17789d9bea89a689338776e670c.tar.xz
Update README for the now general bot behaviour
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index 60f0d25..0abf9b0 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,22 @@
# sax robot
-saxrobot/saxbot is a novelty IRC bot who matches any mention of the string "sax"
-in any part of an IRC message in the channels it monitors, with as many
-saxaphone icons (🎷) as there were instances of "sax" throughout each message.
+saxrobot/saxbot is a novelty IRC bot who counts user-set trigger words in
+IRC channel messages and constructs a reply of user-set replies for each
+instance of a trigger word in a message.
+
+It's hard to word it nicely, so here's an example.
## Example:
+Under the default configuration, saxrobot will trigger on 'sax', 'trumpet'
+and 'snake', replying with '🎷', '🎺' and '🐍' respectively. Take a look at
+this IRC log:
+
<someuser> sax
<somesaxbot> 🎷
- <someuser> saxaphone woosaxSAXalright
- <somesaxbot> 🎷 🎷 🎷
+ <someuser> sax snake
+ <somesaxbot> 🎷 🐍
+ <someuser> saxaphone woosaxsnakeSAXalright trumpetTRUMPET
+ <somesaxbot> 🎷 🎷 🐍 🎷 🎺 🎺
Simple eh.