From 8adefd9fda1dc92010b939dedc187511806c1630 Mon Sep 17 00:00:00 2001 From: Florian Eckerstorfer Date: Sat, 15 Feb 2014 13:02:57 +0100 Subject: [PATCH] Updated README --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca4c374..52501d0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ Guard::Sculpin ============== -Guard::Sculpin automatically generates a Sculpin site when a source file changes. +[Guard](https://github.com/guard/guard)::Sculpin automatically generates a [Sculpin](https://sculpin.io) site when a source file changes. Installation ------------ +Before you start make sure that you have Guard installed. It's best to use [Bundler](http://bundler.io) to install Guard and Guard::Sculpin. + Add Guard::Sculpin to your Gemfile ```ruby @@ -37,6 +39,8 @@ Guard::Sculpin has some options you can set. The default configuration assumes you used Composer to install Sculpin. If you have Sculpin installed globally you should change `:binary` to `sculpin`. +You can find more information on how Guard works in the [Guard usage documentation](http://github.com/guard/guard#readme). + ### Example Guard definition ```ruby