Add a description and usage.

ursm · Aug 26, 2011 · 0e57ab8 · 0e57ab8
1 parent 264570d
commit 0e57ab8
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.rdoc b/README.rdoc
@@ -1,6 +1,17 @@
 = capistrano-notification
 
-Description goes here.
+This allow to notify the end of the deployment on IRC.
+
+== Usage
+
+  require 'capistrano-notification'
+
+  notification.irc do |irc|
+    irc.host    'chat.freenode.net'
+    irc.channel '#rubykaigi.org'
+    irc.message { "#{local_user} deployed #{application} to #{deploy_target}" }
+  end
+
 
 == Note on Patches/Pull Requests