README.rdoc in libnotify-0.0.1 vs README.rdoc in libnotify-0.0.2
- old
+ new
@@ -4,29 +4,34 @@
== Usage
require 'libnotify'
- # Using a block
+ # Block syntax
Libnotify.new do |notify|
notify.summary = "world"
notify.body = "hello"
- notify.timeout = 1.5 # or 1000ms, nil, false
- notify.urgency = :critical # or :low, :normal, :critical
+ notify.timeout = 1.5 # 1.5 (s), 1000 (ms), "2", nil, false
+ notify.urgency = :critical # :low, :normal, :critical
notify.icon_path = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
notify.show!
end
- # Alternative syntax
+ # Hash syntax
Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)
+ # Mixed syntax
+ Libnotify.show(options) do |n|
+ n.timeout = 1.5 # overrides :timeout in options
+ end
+
== Install via gemcutter
gem install gemcutter
gem tumble
gem install libnotify
== Authors
* Peter Suschlik
== TODO
-* Tests!
+* Mock FFI calls