README.rdoc in robut-0.3.0 vs README.rdoc in robut-0.4.0

@@ -1,9 +1,19 @@
 = Robut
 
-The friendly plugin-enabled HipChat bot. 
+The friendly plugin-enabled HipChat bot.
 
+== NOTE: Breaking backwards compatibility!
+
+A little while ago, HipChat changed the way their mention names
+work. Instead of just using the first name ('@robut'), they now use
+the full name ('@RobutTRobot'). Starting from v0.4.0, robut uses this
+new format by default. If you prefer the old style, you can set it in
+your Chatfile:
+
+  config.mention_name = 'robut'
+
 == Installation and usage
 
 Robut can be installed by running <tt>gem install robut</tt>. This
 installs the +robut+ binary. When run, +robut+ reads a Chatfile,
 connects to the specified HipChat server and chatroom, and feeds every
@@ -20,13 +30,16 @@
 
 Some of the included plugins require extra gems to be installed:
 
 [Robut::Plugin::TWSS] requires the <tt>twss</tt> gem.
 [Robut::Plugin::Calc] requires the <tt>calc</tt> gem.
-[Robut::Plugin::Rdio] requires the <tt>rdio</tt> and <tt>sinatra</tt> gems.
 [Robut::Plugin::Weather] requires the <tt>nokogiri</tt> gem.
+[Robut::Plugin::GoogleImages] requires the <tt>google-search</tt> gem.
 
+A list of known 3rd-party plugins is available on the wiki: https://github.com/justinweiss/robut/wiki/Robut-Plugins
+Feel free to add your own creations!
+
 == The Chatfile
 
 When the +robut+ command runs, it looks for and evals ruby code in a
 file called +Chatfile+ in the current directory. You can override the
 configuration file by passing +robut+ a path to a Chatfile as the
@@ -51,11 +64,11 @@
 kind of configuration they support.
 
 Some plugins might require storage (like the `lunch` plugin).  You can
 configure the type of storage you want to use based on the need for
 persistence.  The default is the HashStore which is in-memory only.  Below
-is an example of using the YamlStore.  
+is an example of using the YamlStore.
 
   Robut::Connection.configure do |config|
     # ...
     Robut::Storage::YamlStore.file = "~/.robut_store"
     config.store = Robut::Storage::YamlStore
@@ -69,17 +82,20 @@
 
   # Configure the robut jabber connection and you're good to go!
   Robut::Connection.configure do |config|
     config.jid = '[e-mail]/bot'
     config.password = 'password'
-    config.nick = 'My Nick'
-    config.room = '[e-mail]'
-    
+    config.nick = 'Bot Nick'
+    config.rooms = ['[e-mail]', '[e-mail]']
+
+    # Custom @mention name
+    config.mention_name = 'Bot'
+
     # Example of the YamlStore which uses a yaml file for persistence
     Robut::Storage::YamlStore.file = "~/.robut_store"
     config.store = Robut::Storage::YamlStore
-    
+
     # Add a logger if you want to debug the connection
     # config.logger = Logger.new(STDOUT)
   end
 
 This block usually goes at the end of the Chatfile.
@@ -96,58 +112,62 @@
 [Robut::Plugin::Lunch] a random decider for lunch locations.
 
   @robut lunch? # => "Banh Mi!"
 
 
-[Robut::Plugin::Meme] an interface to memecaptain. 
+[Robut::Plugin::Meme] generates meme images using memecaptain.
 
   @robut meme all_the_things drink; all the beer
 
+[Robut::Plugin::GoogleImages] does a google image search for a query and returns the first result.
 
-[Robut::Plugin::Sayings] a simple regex listener and responder. 
+  @robut image ship it
 
+[Robut::Plugin::Sayings] a simple regex listener and responder.
+
   You're the worst robot ever, @robut. # => I know.
 
-[Robut::Plugin::TWSS] an interface to the TWSS gem. Listens to anything said in the chat room and responds "That's what she said!" where appropriate. 
+[Robut::Plugin::TWSS] an interface to the TWSS gem. Listens to anything said in the chat room and responds "That's what she said!" where appropriate.
 
   well hurry up, you're not going fast enough # => "That's what she said!"
 
 
 [Robut::Plugin::Echo] echo back whatever it gets.
 
   @robut echo hello world # => "hello world"
 
 
-[Robut::Plugin::Say] invokes the "say" command (text-to-speech). 
+[Robut::Plugin::Say] invokes the "say" command (text-to-speech).
 
   @robut say this rocks # (make sure robut is running on a machine with speakers :)
 
 
-[Robut::Plugin::Ping] responds with "pong". 
+[Robut::Plugin::Ping] responds with "pong".
 
   @robut ping # => "pong"
 
 
 [Robut::Plugin::Later] performs the given command after waiting an arbitrary amount of time.
 
   @robut in 5 minutes echo @justin wake up! # => (5 minutes later) "@justin wake up!"
 
 
-[Robut::Plugin::Rdio] uses the Rdio[http://www.rdio.com] API and a simple web server to queue and play songs on Rdio.
-
-  @robut play ok computer
-
-
 [Robut::Plugin::Weather] uses Google Weather to fetch for the weather for a given location and day.
 
   @robut seattle weather saturday? # => "Forecast for Seattle, WA on Sat: Sunny, High: 77F, Low: 55F"
 
 [Robut::Plugin::Alias] creates aliases to other robut commands.
 
   @robut alias "cowboy" "@robut play bon jovi wanted dead or alive" # Cuz somtimes you need it.
   @robut alias w weather? # less typing for common stuff
 
+[Robut::Plugin::Quips] stores and posts Bugzilla-style quips.
+
+  @robut add quip It was great when I wrote it!
+  @robut quip # => It was great when I wrote it!
+  @robut remove quip It was great when I wrote it!
+
 [Robut::Plugin::Help] lists usage for all the plugins loaded into robut
 
   @robut help # => command usage
 
 == Writing custom plugins
@@ -177,7 +197,6 @@
 5. Send me a pull request
 6. That's it!
 
 == Todo
 
-* Support connections to multiple rooms
-* More plugins!
\ No newline at end of file
+* More plugins!