README.rdoc in guard-0.2.1 vs README.rdoc in guard-0.2.2
- old
+ new
@@ -2,11 +2,11 @@
Guard is a command line tool to easly handle events on files modifications.
== Features
-- {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support on Mac OS X 10.5+ (without RubyCocoa!, {rb-fsevent gem, >= 0.3.2}[https://rubygems.org/gems/rb-fsevent] required)
+- {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support on Mac OS X 10.5+ (without RubyCocoa!, {rb-fsevent gem, >= 0.3.5}[https://rubygems.org/gems/rb-fsevent] required)
- {Inotify}[http://en.wikipedia.org/wiki/Inotify] support on Linux ({rb-inotify gem, >= 0.5.1}[https://rubygems.org/gems/rb-inotify] required)
- Polling for others (help us to support more systems)
- Super fast change detection (when polling not used)
- Automatic files modifications detection (even new files are detected)
- Growl notification ({growlnotify}[http://growl.info/documentation/growlnotify.php] & {growl gem}[https://rubygems.org/gems/growl] required)
@@ -37,20 +37,28 @@
Install growl for Growl notification support
gem install growl
+And add it to you Gemfile
+
+ gem 'growl'
+
=== On Linux
Install rb-inotify for {inotify}[http://en.wikipedia.org/wiki/Inotify] support
gem install rb-inotify
Install libnotify for libonity notification support
gem install libnotify
+And add it to you Gemfile
+
+ gem 'libnotify'
+
== Usage
Just launch Guard inside your ruby/rails project with:
guard
@@ -74,17 +82,19 @@
- {guard-rspec}[http://github.com/guard/guard-rspec]
- {guard-test}[http://github.com/guard/guard-test]
- {guard-minitest}[http://github.com/guard/guard-minitest]
- {guard-livereload}[http://github.com/guard/guard-livereload]
- {guard-sass}[http://github.com/guard/guard-sass]
+- {guard-compass}[http://github.com/guard/guard-compass]
- {guard-shell}[http://github.com/guard/guard-shell]
+- {guard-bundler}[http://github.com/guard/guard-bundler]
+- {guard-passenger}[http://github.com/guard/guard-passenger]
guard ideas:
- guard-spork
- guard-cucumber
-- guard-bundler
- others ideas?
=== Add a guard to your Guardfile
Add it to your Gemfile (inside test group):
@@ -123,10 +133,12 @@
# Call once when guard starts
def start
true
end
- # Call with Ctrl-C signal (when Guard quit)
+ # Call with Ctrl-C signal (when Guard quit).
+ # This method must return a true value
+ # if everything went well or guard will not stop.
def stop
true
end
# Call with Ctrl-Z signal
\ No newline at end of file