README.md in guard-rails-0.3.4 vs README.md in guard-rails-0.4.0
- old
+ new
@@ -3,25 +3,43 @@
[](http://badge.fury.io/rb/guard-rails)
[](https://travis-ci.org/ranmocy/guard-rails)
[](https://gemnasium.com/ranmocy/guard-rails)
[](https://codeclimate.com/github/ranmocy/guard-rails)
-## Want to restart your Rails development server whilst you work? Now you can!
+## Main repository
+Currently, the official fork repository is at [ranmocy/guard-rails](http://github.com/ranmocy/guard-rails).
+Please, come here and communicate with me.
- guard 'rails', :port => 5000 do
- watch('Gemfile.lock')
- watch(%r{^(config|lib)/.*})
- end
+## Install
+Please make sure to have [Guard](https://github.com/guard/guard) installed before continue.
+
+Add Guard::Rails to your `Gemfile`:
+
+```ruby
+group :development do
+ gem 'guard-rails'
+end
+```
+
+Add the default Guard::Rails template to your `Guardfile` by running:
+
+```bash
+$ guard init rails
+```
+
+Now I can automatically restart your Rails development server as your files changed!
+
## Lots of fun options growing!
* `:daemon` runs the server as a daemon, without any output to the terminal that ran `guard` (**default `false`**)
* `:debugger` enable the debugger in server. Required ruby-debug gem. (**default `false`**)
* `:environment` is the server environment (**default `development`**)
* `:force_run` kills any process that's holding the listen port before attempting to (re)start Rails (**default `false`**)
* `:pid_file` specify your pid\_file (**default `tmp/pids/[RAILS_ENV].pid`**)
* `:port` is the server port number (**default `3000`**)
+* `:root` lets you specify the Rails root, i.e. for using guard-rails to run a dummy app within an engine (try `:root => '/spec/dummy'`).
* `:server` the webserver engine to use (**try `:server => :thin`**)
* `:start_on_start` will start the server when starting Guard (**default `true`**)
* `:timeout` waits when restarting the Rails server, in seconds (**default `30`**).
* `:zeus_plan` the [custom plan](https://github.com/burke/zeus/blob/master/docs/ruby/modifying.md) in zeus, only works when `zeus` option is `true` (**default `server`**)
* `:zeus` support [zeus](https://github.com/burke/zeus) to boost rails init speed (**default `false`**).
@@ -30,14 +48,17 @@
## How-to
* **Multiple instances** use `pid_file` option to run multiple instances with same rails\_env
## Contribute
-Feel free to fork'n'fix for any willing.
-Or
+The best choise to contact me is the Issues and Pull Request system on GitHub.
+Currently the official fork repository is at [ranmocy/guard-rails](http://github.com/ranmocy/guard-rails).
-Tell.me in: any.way
+Please, post your issue or pull request there.
+And I will be there as your call.
## Philosophy
+* **All Platforms** MRI is the main test case. But will be tested under REE and JRuby.
+* **Live in edge** I am tested under Ruby 1.8.7, 1.9.3, 2.0.0 with newest gems. Will be rewrited to fit Ruby 2.0.0 when I am released as version 1.0.0.
* [Semantic Version](http://semver.org/)