From f9645ae4acef3f4ead6627afbc1b009afdaef18d Mon Sep 17 00:00:00 2001
From: visionmedia <tj@vision-media.ca>
Date: Wed, 8 Apr 2009 11:45:56 -0700
Subject: [PATCH] Docs

---
 README.rdoc | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.rdoc b/README.rdoc
index 43474c9..146465d 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -3,6 +3,39 @@
 
 Ruby growlnotify 'bindings'.
 
+== Examples
+
+  notification = Growl.new
+  notification.message = 'Hello World'
+  notification.sticky!
+  notification.icon = :jpeg
+  notification.run
+
+  # OR
+
+  Growl {
+    self.message = 'Hello World'
+    self.icon = :jpeg
+    sticky!
+  }
+
+  # OR
+
+  Growl do |n|
+    n.message = 'Hello World'
+    n.icon = :jpeg
+    n.stick!
+  end
+
+== Features
+
+* Check availability with Growl#installed?
+* Check dependencies with Growl#version
+* Use images, icon paths, application icons, or file format icons
+* Sticky a notification making it appear until explicitly closed 
+* Set notification priority 
+* Etc (consult growlnotify --help) 
+
 == License:
 
 (The MIT License)