From 2e1de98df904e96121607bad1bef0447de684e48 Mon Sep 17 00:00:00 2001 From: reality Date: Sun, 30 Dec 2012 19:47:53 +0000 Subject: [PATCH] Module documentation for Report [#75] --- modules/report/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 modules/report/README.md diff --git a/modules/report/README.md b/modules/report/README.md new file mode 100644 index 0000000..e0ca6ae --- /dev/null +++ b/modules/report/README.md @@ -0,0 +1,19 @@ +## Report + +Report users + +### Description +This module provides a command which allows users to report other users in a +channel to the operators of the channel, as well as posting an alert in the +administrative channel. It can be done either anonymously or publicly in the +channel. + +### Commands + +#### ~report [#channel] [username] [reason for reporting] +Report a user in a channel for a reason. This command can either be run publicly +in a channel or anonymously in a PM to the bot. The result of using this command +will be that all of the users which are currently marked as operators in the +reporting channel will receive a PM telling them a user has been reported, by +whom, in which channel and why. If there is an administrative channel for the +reporting channel (e.g. ##channel), the report will be posted there as well.