README.md in guard-rails-0.4.7 vs README.md in guard-rails-0.5.0
- old
+ new
@@ -4,16 +4,16 @@
[](https://travis-ci.org/ranmocy/guard-rails)
[](https://gemnasium.com/ranmocy/guard-rails)
[](https://codeclimate.com/github/ranmocy/guard-rails)
## Main repository
-Currently, the official fork repository is at [ranmocy/guard-rails](http://github.com/ranmocy/guard-rails).
+Currently, the official fork repository is at [ranmocy/guard-rails][ranmocy-guard-rails].
Please, come here and communicate with me.
## Install
-Please make sure to have [Guard](https://github.com/guard/guard) installed before continue.
+Please make sure to have [Guard][guard] installed before continuing.
Add Guard::Rails to your `Gemfile`:
```ruby
group :development do
@@ -25,57 +25,70 @@
```bash
$ guard init rails
```
-Now I can automatically restart your Rails development server as your files changed!
+Now I can automatically restart your Rails development server as your files change!
## 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`**)
+* `:daemon` runs the server as a daemon, without any output to the terminal that started `guard` (**default `false`**)
+* `:debugger` enable the debugger in server. Requires 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`**).
-* `:CLI` construct the runner command as your willing! Will omit all options above except `pid_file`! (**default `rails server --pid tmp/pids/[RAILS_ENV].pid`**)
+* `:zeus_plan` the [custom plan][zeus-custom-plan] in zeus, only works when `zeus` option is `true` (**default `server`**)
+* `:zeus` support [zeus][zeus] to boost rails init speed (**default `false`**).
+* `:CLI` construct the runner command as you will! Will omit all options above except `pid_file`! (**default `rails server --pid tmp/pids/[RAILS_ENV].pid`**)
## How-to
-* **Multiple instances** use `pid_file` option to run multiple instances with same rails\_env
+* **Multiple instances** use `pid_file` option to run multiple instances with same rails\_env.
+* **Avoid multiple autoruns when editing by VIM and Emacs** move the backup files to somewhere else or just ignore them in Guardfile.
## Philosophy
* **All Platforms** MRI is the main test case. But will be tested under REE and JRuby.
-* **Live in edge** Ruby 1.8.7 has been deprecated. Guard-Rails will be tested under Ruby 1.9.3, 2.0.0 with newest gems. Will be rewrited with features of Ruby 2.0.0 as version 1.0.0.
+* **Live on the edge** Ruby 1.8.7 has been deprecated. Guard-Rails will be tested under Ruby 1.9.3, 2.0.0 with newest gems. Will be rewrited with features of Ruby 2.0.0 as version 1.0.0.
* [Semantic Version](http://semver.org/)
## Contribute
-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).
+The best way to contact me is the Issues and Pull Request system on GitHub.
+Currently the official fork repository is at [ranmocy/guard-rails][ranmocy-guard-rails].
-Please, post your issue or pull request there.
+Please, post your issues or pull requests there.
And I will be there as your call.
-## Contributor
+## Contributors
* Ranmocy Sheng
* John Bintz
+* cablegram
* Joel Moss
* Sidney Burks
* Paul Schyska
-* Tim Preston
-* Nathan Broadbent
* Adam Michel
-* Benjamin Sullivan
+* Nathan Broadbent
+* Tim Preston
+* killphi
+* Grant Hutchins and Jonathan Mukai-Heidt
* Everard Brown
* Darrin Holst
-* Grant Hutchins and Jonathan Mukai-Heidt
* Michel Pavan Macedo
-* cablegram
+* Benjamin Sullivan
+* Johnny Robeson
+
+## Copyright
+
+Guard-rails is under **[FOLLOW YOUR HEART PUBLIC LICENSE][FYHPL]** version 1.
+
+[ranmocy-guard-rails]: http://github.com/ranmocy/guard-rails
+[guard]: https://github.com/guard/guard
+[zeus]: https://github.com/burke/zeus
+[zeus-custom-plan]: https://github.com/burke/zeus/blob/master/docs/ruby/modifying.md
+[FYHPL]: http://ranmocy.info/piece/FYHPL.txt