hubot-catme2/README.md

Catme is the most importantest hubot script. This script is based on hubot-catme but uses an API key to get more images.

# hubot-catme2

A hubot script that fetches random cat images.

This script is based on the [hubot-catme](https://github.com/Emile-Filteau/hubot-catme) script by [Emile Filteau](https://github.com/Emile-Filteau).
It uses an API key so we can have access to all images in The Cat API.

See [`src/catme.coffee`](src/catme.coffee) for full documentation.

## Installation

In hubot project repo, run:

`npm install hubot-catme2 --save`

Then add **hubot-catme2** to your `external-scripts.json`:

```json
[
  "hubot-catme2"
]
```

## Configuration

You need to set the `HUBOT_THE_CAT_API_KEY` environment variable which can be obtained from http://thecatapi.com/api-key-registration.html


## Sample Interaction

```
user1>> hubot cat me
hubot>> http://24.media.tumblr.com/tumblr_mbi8dcCrzo1qlyuwso1_1280.jpg

user1>> hubot cat categories
hubot>> hats
space
funny
sunglasses
boxes
caturday
ties
dream
kittens
sinks
clothes
```