From 6f5105e36c3f9bfb7517ceea44c668822d91718e Mon Sep 17 00:00:00 2001 From: reality Date: Sun, 30 Dec 2012 18:12:23 +0000 Subject: [PATCH] Module documentation for Link [#75] --- modules/link/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 modules/link/README.md diff --git a/modules/link/README.md b/modules/link/README.md new file mode 100644 index 0000000..5b83bce --- /dev/null +++ b/modules/link/README.md @@ -0,0 +1,21 @@ +## Link + +Retrieves page titles. + +### Description + +This module stores the last posted link in each channel, and provides a command +for retrieving the title of a given link or the last posted link in the channel. + +### Configuration + +#### autoTitle: false +If this is set to true, the bot will automatically post the titles of links as +they are posted in the channel. + +### Commands + +#### ~title [link] +If called with a link, the bot will attempt to find and return the title of that +page. If called without a link, the bot will attempt the same on the last link +which was posted in the current channel.