From 0302aa9f5967df77b85117f556b376422911d59e Mon Sep 17 00:00:00 2001 From: jonschlinkert Date: Wed, 4 Mar 2015 14:58:18 -0500 Subject: [PATCH] update docs: breaking changes: - now takes an options object instead of a string --- .verb.md | 13 +++++++++++++ README.md | 15 ++++++++++++++- 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/.verb.md b/.verb.md index f945a96..9284a52 100644 --- a/.verb.md +++ b/.verb.md @@ -18,6 +18,19 @@ git(function (err, config) { }); ``` +**Custom path and/or cwd** + +```js +git.sync({cwd: 'foo', path: '.git/config'}); + +// async +git({cwd: 'foo', path: '.git/config'}, function (err, config) { + // do stuff +}); +``` + +**Example result** + Config object will be something like: ```js diff --git a/README.md b/README.md index 5e70db6..9e5f5c3 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,19 @@ git(function (err, config) { }); ``` +**Custom path and/or cwd** + +```js +git.sync({cwd: 'foo', path: '.git/config'}); + +// async +git({cwd: 'foo', path: '.git/config'}, function (err, config) { + // do stuff +}); +``` + +**Example result** + Config object will be something like: ```js @@ -63,4 +76,4 @@ Released under the MIT license *** -_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on February 27, 2015._ +_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 04, 2015._