aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Phillips <david@sighup.nz>2018-04-10 15:40:46 +1200
committerDavid Phillips <david@sighup.nz>2018-04-10 15:40:46 +1200
commit72fa2c6d1864fdf4174af5b6f8b8e87bc295bb7d (patch)
tree0551f6a97ed9ea33ff491a2780aa0a9b1421d88b
parent5504bcd369b33874c92e49c2383e5f73d1a5a702 (diff)
downloadidalius-72fa2c6d1864fdf4174af5b6f8b8e87bc295bb7d.tar.xz
Fill out new modules' summaries in README
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 568f91a..38c6bd8 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,36 @@ this IRC log:
Simple eh.
+## Module: Antiflood
+
+This module will kick someone who send more than 5 messages in 11 seconds on
+a channel. It's on the to-do list to make these parameters configurable.
+
+## Module: Echo
+
+This module adds a command to echo strings on-channel. Example:
+
+ <someone> %echo woo stuff
+ <somebot> woo stuff
+
+## Module: Map
+
+This module allows simplistic mapping of a function across a list of arguments.
+At the moment, array syntax is just prototypical, and uses regex to split on
+commas. Thus, nesting of , within arguments is not yet possible. Examples:
+
+ <someone> %map echo foo,bar, foobar
+ <somebot> [foo, bar, foobar]
+
+## Module: Timezone
+
+This module allows timezones to be associated with words (intended for use
+with nicks) so that the command `%time foo` will return the current time,
+adjusted for the timezone associated with `foo`. Example:
+
+ <person1> %time person1
+ <somebot> person1: person1's clock reads 2018-04-10T06:39:44
+
## Admin commands
idalius also supports some basic administration commands. These should be sent