From 111ce32be63cb17789d9bea89a689338776e670c Mon Sep 17 00:00:00 2001 From: David Phillips Date: Fri, 17 Mar 2017 16:31:41 +1300 Subject: Update README for the now general bot behaviour --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) (limited to 'README.md') 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: + sax 🎷 - saxaphone woosaxSAXalright - 🎷 🎷 🎷 + sax snake + 🎷 🐍 + saxaphone woosaxsnakeSAXalright trumpetTRUMPET + 🎷 🎷 🐍 🎷 🎺 🎺 Simple eh. -- cgit v1.1