Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Eckerstorfer committed Feb 15, 2014
1 parent 165ad38 commit 8adefd9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion 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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 8adefd9

Please sign in to comment.