Module documentation for Link [#75]

2012-12-30 18:12:23 +00:00 · 2012-12-30 18:12:23 +00:00 · 6f5105e36c
commit 6f5105e36c
parent 26e731697d
1 changed files with 21 additions and 0 deletions
--- a/modules/link/README.md
+++ 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.