aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Phillips <david@sighup.nz>2017-03-06 12:53:22 +1300
committerDavid Phillips <david@sighup.nz>2017-03-06 12:53:22 +1300
commite1a382c7db700b1dc5a9e3e859f4579367624323 (patch)
tree218e5df0111737e4c07abe78cfe3cbe1fe30e85b /README.md
parent22238a3f9f8d570d7f80957ff972cc29ffce31cd (diff)
downloadidalius-e1a382c7db700b1dc5a9e3e859f4579367624323.tar.xz
Add simple example readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..60f0d25
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# 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.
+
+## Example:
+
+ <someuser> sax
+ <somesaxbot> 🎷
+ <someuser> saxaphone woosaxSAXalright
+ <somesaxbot> 🎷 🎷 🎷
+
+Simple eh.