From b4a8bb8d263bffe5d716e67b959052a770faccd1 Mon Sep 17 00:00:00 2001 From: Kaanon MacFarlane Date: Fri, 6 Jun 2014 11:54:15 -0700 Subject: [PATCH] Update readme.md explain the options more clearly. --- readme.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 7e94a9d..cee7707 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# [gulp](https://github.com/wearefractal/gulp)-compile-handlebars +# gulp-compile-handlebars Forked from [gulp-template](https://github.com/sindresorhus/gulp-template) Inspired by [grunt-compile-handlebars](https://github.com/patrickkettner/grunt-compile-handlebars) @@ -17,7 +17,7 @@ npm install --save-dev gulp-compile-handlebars ### `src/hello.handlebars` -```erb +```handlebars

Hello {{firstName}}

HELLO! {{capitals firstName}}

{{> footer}} @@ -61,6 +61,13 @@ gulp.task('default', function () { ``` +## Options + +- __ignorePartials__ : ignores any unknown partials. Useful if you only want to handle part of the file +- __partials__ : Javascript object that will fill in partials using strings +- __batch__ : Javascript array of filepaths to use as partials +- __helpers__: javascript functions to stand in for helpers used in the handlebars files + ## License -MIT © [Kaanon MacFarlane](http://kaanon.com) +[MIT](http://opensource.org/licenses/MIT) © [Kaanon MacFarlane](http://kaanon.com)