Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jonschlinkert committed Jul 4, 2013
1 parent 7d3cfa8 commit 87b6a56
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Expand Up @@ -3,12 +3,15 @@
> Quickly create helpers for use with Assemble, using [grunt-init][]. Includes README documentation, test files, metadata, bower.json and package.json.
## Quickstart
If you have `grunt-init` and are familiar with using it:
If you have `grunt-init` and are familiar with using it, `git clone` this repo into the directory that [grunt init](http://gruntjs.com/project-scaffolding#installing-templates) recommends for your operating system. The following is recommended for Windows users.

``` bash
git clone https://github.com/assemble/grunt-init-assemble-helper.git ~/.grunt-init/assemble
```

**Note**: you can make the template available as any name you choose by simply changing the name of the folder that the template is installed into. So instead of `~/.grunt-init/assemble`, you may change the name to `~/.grunt-init/foo` so that the template can be used with the following command: `grunt-init foo`.


Then, in empty directory:

* Run `grunt-init assemble-helper`
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "grunt-init-assemble-helper",
"version": "0.1.2",
"version": "0.1.3",
"description": "Quickly create a Handlebars helper that can easily be used with Assemble",
"homepage": "https://github.com/assemble/grunt-init-assemble-helper/",
"author": {
Expand Down

0 comments on commit 87b6a56

Please sign in to comment.