generate docs

master
jonschlinkert 9 years ago
parent 936b3f17bc
commit fd6b600898

@ -1,4 +1,4 @@
# parse-git-config [![NPM version](https://img.shields.io/npm/v/parse-git-config.svg)](https://www.npmjs.com/package/parse-git-config) [![Build Status](https://img.shields.io/travis/jonschlinkert/parse-git-config.svg)](https://travis-ci.org/jonschlinkert/parse-git-config)
# parse-git-config [![NPM version](https://img.shields.io/npm/v/parse-git-config.svg?style=flat)](https://www.npmjs.com/package/parse-git-config) [![NPM downloads](https://img.shields.io/npm/dm/parse-git-config.svg?style=flat)](https://npmjs.org/package/parse-git-config) [![Build Status](https://img.shields.io/travis/jonschlinkert/parse-git-config.svg?style=flat)](https://travis-ci.org/jonschlinkert/parse-git-config)
> Parse `.git/config` into a JavaScript object. sync or async.
@ -55,7 +55,7 @@ Config object will be something like:
## API
### [parse](index.js#L30)
### [parse](index.js#L33)
Asynchronously parse a `.git/config` file. If only the callback is passed, the `.git/config` file relative to `process.cwd()` is used.
@ -74,7 +74,7 @@ parse(function(err, config) {
});
```
### [.sync](index.js#L67)
### [.sync](index.js#L76)
Synchronously parse a `.git/config` file. If no arguments are passed, the `.git/config` file relative to `process.cwd()` is used.
@ -89,7 +89,7 @@ Synchronously parse a `.git/config` file. If no arguments are passed, the `.git/
var config = parse.sync();
```
### [.keys](index.js#L109)
### [.keys](index.js#L124)
Returns an object with only the properties that had ini-style keys converted to objects (example below).
@ -181,6 +181,8 @@ Results in:
## Related projects
You might also be interested in these projects:
* [git-user-name](https://www.npmjs.com/package/git-user-name): Get a user's name from git config at the project or global scope, depending on… [more](https://www.npmjs.com/package/git-user-name) | [homepage](https://github.com/jonschlinkert/git-user-name)
* [git-username](https://www.npmjs.com/package/git-username): Get the username from a git remote origin URL. | [homepage](https://github.com/jonschlinkert/git-username)
* [parse-author](https://www.npmjs.com/package/parse-author): Parse a string into an object with `name`, `email` and `url` properties following npm conventions.… [more](https://www.npmjs.com/package/parse-author) | [homepage](https://github.com/jonschlinkert/parse-author)
@ -223,9 +225,9 @@ $ npm install -d && npm test
## License
Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/parse-git-config/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on March 19, 2016._
_This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._
Loading…
Cancel
Save