Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Docs

  • Loading branch information...
commit f9645ae4acef3f4ead6627afbc1b009afdaef18d 1 parent 07717a5
@tj authored
Showing with 33 additions and 0 deletions.
  1. +33 −0 README.rdoc
View
33 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)
Please sign in to comment.
Something went wrong with that request. Please try again.