README.markdown in guard-jekyll-1.3.0 vs README.markdown in guard-jekyll-1.4.0
- old
+ new
@@ -1,8 +1,8 @@
# Guard::Jekyll
-This is a guard for [jekyll](http://jekyllrb.com/).
+Guard::Jekyll automatically rebuilds websites with the [Jekyll static site generator](http://jekyllrb.com/) every time files are modified.
## Installation
Add this line to your application's Gemfile:
@@ -16,23 +16,28 @@
$ gem install guard-jekyll
## Usage
-Enter the jekyll site directory for which you want to use Guard::Jekyll. Create a Guardfile using `guard init`:
+Enter the Jekyll site directory for which you want to use Guard::Jekyll. Create a Guardfile using:
$ guard init jekyll
-Execute guard:
+Then execute:
$ guard
-Whenever you change a file in the jekyll site directory now, the site will be rebuilt!
+Whenever you change a file in the Jekyll site directory now, the site will be rebuilt!
## Options
-* `:source` the source directory which jekyll reads files from (default `'./'`)
-* `:destination` the directory where Jekyll will write files to (default is `'./_site'`)
-* `:config` array of configuration files which jekyll will read (default `['./_config.yml']`)
+
+You can provide these options to Guard::Jekyll:
+
+* `:source` the source directory which Jekyll reads files from.
+* `:destination` the directory where Jekyll will write files to.
+* `:config` array of configuration files for Jekyll.
+
+Without options, Jekyll will use its built-in defaults.
## License
(MIT License)