README.md in cinch-urbandict-0.0.1 vs README.md in cinch-urbandict-0.0.2

- old
+ new

@@ -1,8 +1,8 @@ -# Cinch::Urbandict +# Cinch::Plugins::Urbandict -TODO: Write a gem description +Simple Cinch Plugin to fetch Urbandictionary defs. ## Installation Add this line to your application's Gemfile: @@ -16,10 +16,20 @@ $ gem install cinch-urbandict ## Usage -TODO: Write usage instructions here +Just add the plugin to your list: + + @bot = Cinch::Bot.new do + configure do |c| + c.plugins.plugins = [Cinch::Plugins::UrbanDict] + end + end + +Then in channel use: + + .ud kitten ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)