diff --git a/zulip_bots/zulip_bots/bots/giphy/assets/giphy-connection-error.png b/zulip_bots/zulip_bots/bots/giphy/assets/giphy-connection-error.png new file mode 100644 index 0000000..ec8eefa Binary files /dev/null and b/zulip_bots/zulip_bots/bots/giphy/assets/giphy-connection-error.png differ diff --git a/zulip_bots/zulip_bots/bots/giphy/assets/giphy-gif-found.png b/zulip_bots/zulip_bots/bots/giphy/assets/giphy-gif-found.png new file mode 100644 index 0000000..782840b Binary files /dev/null and b/zulip_bots/zulip_bots/bots/giphy/assets/giphy-gif-found.png differ diff --git a/zulip_bots/zulip_bots/bots/giphy/assets/giphy-gif-not-found.png b/zulip_bots/zulip_bots/bots/giphy/assets/giphy-gif-not-found.png new file mode 100644 index 0000000..adbbb1d Binary files /dev/null and b/zulip_bots/zulip_bots/bots/giphy/assets/giphy-gif-not-found.png differ diff --git a/zulip_bots/zulip_bots/bots/giphy/doc.md b/zulip_bots/zulip_bots/bots/giphy/doc.md new file mode 100644 index 0000000..cd8597e --- /dev/null +++ b/zulip_bots/zulip_bots/bots/giphy/doc.md @@ -0,0 +1,42 @@ +# GIPHY bot + +The GIPHY bot is a Zulip bot that can fetch a GIF associated with +a given keyword from [GIPHY](https://giphy.com/). + +To use the GIPHY bot, you can simply call it with `@Giphy` followed +by a keyword, like so: + +``` +@Giphy hello +``` + +## Setup + +Before you can proceed further, you'll need to go to the +[GIPHY Developers](https://developers.giphy.com/), and get a +GIPHY API key. + +1. Click on the **Create an App** button on the top right corner. +2. Click on **Create an App** under the **Your Apps** section. +3. Enter a name and a description for your app and click on + **Create New App**. +4. And you're done! You should now have a GIPHY API key. +5. Open up `zulip_bots/bots/giphy/giphy.conf` in an editor and + and change the value of the `key` attribute to the API key + you generated above. + +{!running-a-bot.md!} + +## Usage + +1. `@Giphy