README.md in guard-livereload-1.4.0 vs README.md in guard-livereload-2.0.0
- old
+ new
@@ -1,7 +1,9 @@
-# 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)
+# 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.
@@ -18,11 +20,11 @@
Add it to your Gemfile (inside development group):
``` ruby
group :development do
- gem 'guard-livereload'
+ gem 'guard-livereload', require: false
end
```
Add guard definition to your Guardfile by running this command:
@@ -32,16 +34,16 @@
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-)
## 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)
+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](http://github.com/mockko/livereload#readme)
## Guardfile
You can adapt your 'view' files like you want.
-Please read [Guard doc](http://github.com/guard/guard#readme) for more info about Guardfile DSL.
+Please read [Guard doc](https://github.com/guard/guard#readme) for more info about Guardfile DSL.
``` ruby
guard 'livereload' do
watch(%r{app/views/.+\.(erb|haml|slim)})
watch(%r{app/helpers/.+\.rb})
@@ -63,17 +65,17 @@
```
Available options:
``` ruby
-: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)
+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)
```
-See [LiveReload configuration doc](http://github.com/mockko/livereload#readme) for more info about those options.
+See [LiveReload configuration doc](https://github.com/mockko/livereload#readme) for more info about those options.
## 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).