From ed73afd2666b9cbe8941e4c3d758cd39af925f05 Mon Sep 17 00:00:00 2001 From: Ben Kurtovic Date: Tue, 15 Sep 2015 13:47:52 -0500 Subject: [PATCH] Add docs for !welcome. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index e011491..635542d 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,13 @@ IRC Commands stored in its config as `"apiKey"`, which should be stored encrypted if that option is enabled. +- **welcome**: automatically welcomes people who join a particular channel. + Welcoming is restricted to web IRC users, i.e. users whose hostname starts + with `gateway/web/`. In the command's config section, use channel names as + keys and welcome messages as values; the string `{nick}` will be replaced by + their nickname. The `!welcome` command can be used by bot admins to enable or + disable welcomes in a particular channel. + Bot Tasks ---------