README.markdown in guard-jekyll-1.1.0 vs README.markdown in guard-jekyll-1.2.0

- old
+ new

@@ -1,27 +1,42 @@ -## What? -Run jekyll for you. +# Guard::Jekyll -## Use -if you haven't already `gem install jekyll` -then `gem install guard-jekyll` -in your project's directory root -`guard init` -`guard init jekyll` +This is a guard for [jekyll](http://jekyllrb.com/). -which will add this to your Guardfile +## Installation - guard 'jekyll' do - watch /.*/ - end +Add this line to your application's Gemfile: -## TODO -tests + gem 'guard-jekyll' +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install guard-jekyll + +## Usage + +Enter the jekyll site directory for which you want to use Guard::Jekyll. Create a Guardfile using `guard init`: + + $ guard init jekyll + +Execute guard: + + $ guard + +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']`) + ## License -(The MIT License) -Copyright (c) 2011 David Haslem +(MIT License) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.