README.md in guard-livereload-2.4.0 vs README.md in guard-livereload-2.5.0

- old
+ new

@@ -22,21 +22,21 @@ Add it to your Gemfile (inside development group): ``` ruby group :development do - gem 'guard-livereload', require: false + gem 'guard-livereload', '~> 2.4', require: false end ``` Add guard definition to your Guardfile by running this command: ``` bash $ guard init livereload ``` -Use [rack-livereload](https://github.com/johnbintz/rack-livereload) or install [LiveReload Safari/Chrome extension](http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-) +And to get everything running in the browser, use [rack-livereload](https://github.com/johnbintz/rack-livereload) or install the [LiveReload Safari/Chrome/Firefox extension](http://livereload.com/extensions#installing-sections). ## Usage Please read [Guard usage doc](https://github.com/guard/guard#readme) and [rack-livereload how it works readme section](https://github.com/johnbintz/rack-livereload#readme) or [LiveReload extension usage doc](https://github.com/mockko/livereload/blob/master/README-old.md) from version 1.x @@ -73,13 +73,29 @@ host: '127.3.3.1' # default '0.0.0.0' port: '12345' # default '35729' apply_css_live: false # default true override_url: false # default false grace_period: 0.5 # default 0 (seconds) +js_template: './my_livereload.js.erb' # default is livereload.js.erb from gem ``` +Additional custom JS template options (see livereload.js.erb for details): +``` ruby +js_apple_webkit_extra_wait_time: 50 # default is 5 (see issue #123) +js_default_extra_wait_time: 100 # default is 200 +``` + + `notify` uses Guard's [system notifications](https://github.com/guard/guard/wiki/System-notifications). See [LiveReload configuration doc](https://github.com/mockko/livereload/blob/master/README-old.md) from version 1.x for more info about other options. + +## Troubleshooting + +##### 1. "hw.ncpu" is an unknown key. + +Solution: just upgrade the `listen` gem to '3.x' (Listen is used by Guard). + +(Details: https://github.com/guard/guard-livereload/issues/134) ## Development * Source hosted at [GitHub](https://github.com/guard/guard-livereload). * Report issues and feature requests to [GitHub Issues](https://github.com/guard/guard-livereload/issues).