update docs:

breaking changes:
- now takes an options object instead of a string
master
jonschlinkert 10 years ago
parent 6166691232
commit 0302aa9f59

@ -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: Config object will be something like:
```js ```js

@ -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: Config object will be something like:
```js ```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._

Loading…
Cancel
Save