From 85fc4d6e6fd2627737f5ada72d94cf3de9f1466e Mon Sep 17 00:00:00 2001 From: reality Date: Sun, 30 Dec 2012 17:44:51 +0000 Subject: [PATCH] Documentation for the Ignore module [#75] --- modules/ignore/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 modules/ignore/README.md diff --git a/modules/ignore/README.md b/modules/ignore/README.md new file mode 100644 index 0000000..816b059 --- /dev/null +++ b/modules/ignore/README.md @@ -0,0 +1,26 @@ +## Ignore + +Ignore modules. + +### Description + +Commands with which users can choose to ignore listeners and commands from +certain modules persistently, by storing their choices in the database. This is +an interface for the JSBot ignoreTag functionality which actually implements +the ignoration. + +### Configuration + +All modules may return with them an 'ignorable' property, which defines whether +or not their functionality may be ignored by users. + +### Commands + +#### ~ignore [module] +Ignore a given module. If the user does not specify a module, or provides an +invalid one a list of modules which are available to ignore will be given. + +#### ~unignore [module] +Unignore a previously ignored module. If the user does not specify a module, or +provides an invalid choice a list of modules which are currently ignored will be +given.