Contents

# Hawkins
Hawkins is a [Jekyll](http://jekyllrb.com) 3 plugin that incorporates
[LiveReload](http://www.livereload.com) into the Jekyll "serve" process.

## How to Use
Add the following into your `Gemfile`

```
group :jekyll_plugins do
  gem 'hawkins'
end
```

Then run `jekyll liveserve` to serve your files.  The `liveserve` commands takes
all the arguments that `serve` does but with a few extras that allow you to
specify the port that LiveReload runs on or how long LiveReload will wait.  See
the --help for more information.

## How It Works
Hawkins uses a WEBrick servlet that automatically inserts a script tag into a
page's `head` section.  The script tag points to a LiveReload server running on
the same host (by default on port 35729).  That server serves `livereload.js`
over HTTP and also acts as a WebSockets server that speaks the LiveReload
protocol.

If you don't have a browser that implements WebSockets, you can use the
`--swf` option that will have Hawkins load a Flash file that implements
WebSockets.

## A Note on SSL/TLS
If you tell Jekyll to serve your files over SSL/TLS (by specifying the
`--ssl-cert` and `--ssl-key` options), then LiveReload will attempt to use
SSL/TLS as well.  If you are using a certificate that a browser would not
normally accept (e.g.  self-signed or issued by an unknown certificate
authority), you will need to create an exception for the server and port
that Jekyll is serving content over and also for the server and port that
LiveReload is running on.  Generally speaking, these exceptions will be
"127.0.0.1:4000" and "127.0.0.1:35729".

## Thanks
Lots of thanks to [guard-livereload](https://github.com/guard/guard-livereload)
and [rack-livereload](https://github.com/johnbintz/rack-livereload) which
provided a lot of the code and ideas that Hawkins uses.  And of course thanks to
the Jekyll team and LiveReload team for providing outstanding software.

## Copyright
Copyright (c) 2014 Alex Wood. See LICENSE.txt for further details.

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
hawkins-2.0.1	README.md
hawkins-2.0.0	README.md