diff --git a/README.md b/README.md index 48c7ffc..0db5919 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Asynchronously parse a `.git/config` file. If only the callback is passed, the ` **Params** * `options` **{Object|String|Function}**: Options with `cwd` or `path`, the cwd to use, or the callback function. -* `cb` **{Function}**: callback function if the first argument is options or cwd. +* `callback` **{Function}**: callback function if the first argument is options or cwd. * `returns` **{Object}** **Example** @@ -107,9 +107,9 @@ Synchronously parse a `.git/config` file. If no arguments are passed, the `.git/ const config = parse.sync(); ``` -### [.keys](index.js#L150) +### [.expandKeys](index.js#L149) -Returns an object with only the properties that had ini-style keys converted to objects (example below). +Returns an object with only the properties that had ini-style keys converted to objects. **Params** @@ -119,8 +119,8 @@ Returns an object with only the properties that had ini-style keys converted to **Example** ```js -const config = parse.sync(); -const obj = parse.keys(config); +const config = parse.sync({ path: '/path/to/.gitconfig' }); +const obj = parse.expandKeys(config); ``` ### .keys examples @@ -216,6 +216,7 @@ $ npm install && npm test ``` +
Building docs @@ -263,4 +264,4 @@ Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on January 23, 2018._ \ No newline at end of file +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 14, 2018._ \ No newline at end of file