README.md in guard-livereload-1.1.3 vs README.md in guard-livereload-1.2.0

- old
+ new

@@ -1,9 +1,13 @@ -# Guard::LiveReload [![Build Status](https://secure.travis-ci.org/guard/guard-livereload.png)](http://travis-ci.org/guard/guard-livereload) +# Guard::LiveReload [![Gem Version](https://badge.fury.io/rb/guard-livereload.png)](http://badge.fury.io/rb/guard-livereload) [![Build Status](https://travis-ci.org/guard/guard-livereload.png?branch=master)](http://travis-ci.org/guard/guard-livereload) [![Dependency Status](https://gemnasium.com/guard/guard-livereload.png)](https://gemnasium.com/guard/guard-livereload) [![Code Climate](https://codeclimate.com/github/guard/guard-livereload.png)](https://codeclimate.com/github/guard/guard-livereload) [![Coverage Status](https://coveralls.io/repos/guard/guard-livereload/badge.png?branch=master)](https://coveralls.io/r/guard/guard-livereload) LiveReload guard allows to automatically reload your browser when 'view' files are modified. +## Support + +For any support question/issue related to `livereload` please ask on support@livereload.com. + ## Install Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing. Install the gem: @@ -24,20 +28,12 @@ ``` bash $ guard init livereload ``` -Use [rack-livereload](https://github.com/johnbintz/rack-livereload) or install [LiveReload Safari/Chrome extension](http://github.com/mockko/livereload#readme) +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-) -### Optional - -To optimize communication with the LiveReload extension, install the yajl-ruby to increase JSON performance: - -``` bash -$ gem install yajl-ruby -``` - ## Usage Please read [Guard usage doc](http://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](http://github.com/mockko/livereload#readme) ## Guardfile @@ -59,22 +55,20 @@ ## Options LiveReload guard has 6 options that you can set like this: ``` ruby -guard 'livereload', :api_version => '1.4', :port => '35728' do +guard 'livereload' do # ... end ``` Available options: ``` ruby -:api_version => '1.4' # default '1.6' :host => '127.3.3.1' # default '0.0.0.0' -:port => '12345' # default '35729' -:apply_js_live => false # default true :apply_css_live => false # default true +:override_url => false # default false :grace_period => 0.5 # default 0 (seconds) ``` See [LiveReload configuration doc](http://github.com/mockko/livereload#readme) for more info about those options.