From a28a8885dce2a25ef8e96880ece27287b23d0eed Mon Sep 17 00:00:00 2001 From: David Phillips Date: Tue, 26 Sep 2017 23:18:20 +1300 Subject: Describe modules in README instead of old monolithic bot behaviour --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 81dbeb2..a864b39 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ # idalius -idalius 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. +idalius started out as a novelty IRC bot. Its original functionality has now +been moved into an optional module, "tittilate", while the remainder of the +bot's functionality is mostly configurable and extensible. -It's hard to word it nicely, so here's an example. +## Module: URL Title -## Example: +idalius can pick a URL out of any channel message and respond in-channel with +the title of the link, followed by the domain name (really just the bit in +between the first `//` and the first `/` in brackets, so you know roughly what +link the title is for, without being overly verbose. + + Testing the URL title thingy https://sighup.nz/ and presuming it works + Ahoy-hoy ☃ SIGHUP (sighup.nz) + + +## Module: Tittilate + +The tittilate module is one which will ask idalius to check all channel +messages for special keywords, and for each message containing some of those +keywords, respond with a message with as many user-set responses to those +keywords, in order. It's kind of hard to get your head around with plain +words, so I'll give an example. Under the default configuration, idalius will trigger on 'sax', 'trumpet' and 'snake', replying with '🎷', '🎺' and '🐍' respectively. Take a look at -- cgit v1.1