Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Apr 8, 2009
1 parent 07717a5 commit f9645ae
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.rdoc
Expand Up @@ -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)
Expand Down

0 comments on commit f9645ae

Please sign in to comment.