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.