From 72fa2c6d1864fdf4174af5b6f8b8e87bc295bb7d Mon Sep 17 00:00:00 2001 From: David Phillips Date: Tue, 10 Apr 2018 15:40:46 +1200 Subject: Fill out new modules' summaries in README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) 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: + + %echo woo stuff + 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: + + %map echo foo,bar, foobar + [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: + + %time person1 + person1: person1's clock reads 2018-04-10T06:39:44 + ## Admin commands idalius also supports some basic administration commands. These should be sent -- cgit v1.1