README.md in lita-imgflip-memes-1.0.0 vs README.md in lita-imgflip-memes-1.0.1

- old
+ new

@@ -1,23 +1,38 @@ # lita-imgflip-memes [![Build Status](https://travis-ci.org/dpritchett/lita-imgflip-memes.svg?branch=master)](https://travis-ci.org/dpritchett/lita-imgflip-memes) [![Coverage Status](https://coveralls.io/repos/dpritchett/lita-imgflip-memes/badge.svg)](https://coveralls.io/r/dpritchett/lita-imgflip-memes) -TODO: Add a description of the plugin. +Add imgflip meme generation to your Lita bot! +![ancient aliens guy saying 'chat bots'](http://i.imgur.com/FxGSzjVl.jpg) + ## Installation Add lita-imgflip-memes to your Lita instance's Gemfile: ``` ruby gem "lita-imgflip-memes" ``` ## Configuration +The 'lita way' to do this is to open up your `lita_config.rb` and set up file-based configuration: -TODO: Describe any configuration attributes the plugin exposes. +```rb +config.handlers.imgflip_memes.api_user = 'myusername' +config.handlers.imgflip_memes.api_password = 'mypassword' +``` -## Usage +I have set up this gem to deafult to the following environment variables if the config entries aren't set in `lita_config.rb`: -TODO: Describe the plugin's features and how to use them. +```rb + ENV['IMGFLIP_API_USER'] + ENV['IMGFLIP_API_PASSWORD'] +``` +## Usage + +``` +Lita > lita aliens chatbots +http://i.imgflip.com/1tzqwt.jpg +```