From b9bf4125089e937a0b776f0ce847c247fbf63133 Mon Sep 17 00:00:00 2001 From: Ryan Hammett Date: Sun, 17 Jan 2016 22:10:25 -0500 Subject: [PATCH] Another README update --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 1532f11..2f78593 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # Pixivbot This is a Slack bot based on [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot), [slack-mathbot](https://github.com/dblock/slack-mathbot), and inspired by another [Slack Pixiv Bot](https://github.com/castaneai/slack-pixiv-bot). +## Purpose + +When a [Pixiv](http://www.pixiv.net/) link is posted in the channel the Pixiv bot is in, it will "unfurl" the image via message attachements. Pixiv does not allow the images on the site to reside in the metadata, so standard Slack unfurling is unable to preview the image. + +## License + +Do what you want. It's a Slack Bot.