From d76292f6e1164a7ac9e33e5b75071e63586e6163 Mon Sep 17 00:00:00 2001 From: jonschlinkert Date: Fri, 26 Feb 2016 21:39:31 -0500 Subject: [PATCH] update verb config --- .verb.md | 29 -------------------------- README.md | 58 ++++++++++++++++++++++++++++++++-------------------- package.json | 18 +++++++++++++++- 3 files changed, 53 insertions(+), 52 deletions(-) diff --git a/.verb.md b/.verb.md index f9104ff..4497624 100644 --- a/.verb.md +++ b/.verb.md @@ -1,11 +1,3 @@ -# {%= name %} {%= badge("fury") %} {%= badge("travis") %} - -> {%= description %} - -## Install - -{%= include("install-npm", {save: true}) %} - ## Usage ```js @@ -48,24 +40,3 @@ Config object will be something like: fetch: '+refs/heads/*:refs/remotes/origin/*' }, 'branch "master"': { remote: 'origin', merge: 'refs/heads/master', ... } } ``` - - -## Other useful projects -{%= related(verb.related.list) %} - -## Run tests -{%= include("tests") %} - -## Contributing -{%= include("contributing") %} - -## Author -{%= include("author") %} - -## License -{%= copyright() %} -{%= license %} - -*** - -{%= include("footer") %} diff --git a/README.md b/README.md index 3034e7c..c2b0e53 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# parse-git-config [![NPM version](https://badge.fury.io/js/parse-git-config.svg)](http://badge.fury.io/js/parse-git-config) [![Build Status](https://travis-ci.org/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)](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` into a JavaScript object. sync or async. -## Install with [npm](npmjs.org) +## Install -```bash -npm i parse-git-config --save +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install parse-git-config --save ``` ## Usage @@ -51,39 +53,51 @@ Config object will be something like: 'branch "master"': { remote: 'origin', merge: 'refs/heads/master', ... } } ``` -## Other useful projects +## Related projects + +* [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) +* [parse-authors](https://www.npmjs.com/package/parse-authors): Parse a string into an array of objects with `name`, `email` and `url` properties following… [more](https://www.npmjs.com/package/parse-authors) | [homepage](https://github.com/jonschlinkert/parse-authors) +* [parse-github-url](https://www.npmjs.com/package/parse-github-url): Parse a github URL into an object. | [homepage](https://github.com/jonschlinkert/parse-github-url) +* [parse-gitignore](https://www.npmjs.com/package/parse-gitignore): Parse a gitignore file into an array of patterns. Comments and empty lines are stripped. | [homepage](https://github.com/jonschlinkert/parse-gitignore) -* [parse-github-url](https://github.com/jonschlinkert/parse-github-url): Parse a github URL into an object. -* [parse-gitignore](https://github.com/jonschlinkert/parse-gitignore): Parse a gitignore file into an array of patterns. Comments and empty lines are stripped. -* [parse-author](https://github.com/jonschlinkert/parse-author): Parse a string into an object with `name`, `email` and `url` properties following npm conventions.… [more](https://github.com/jonschlinkert/parse-author) -* [parse-authors](https://github.com/jonschlinkert/parse-authors): Parse a string into an array of objects with `name`, `email` and `url` properties following… [more](https://github.com/jonschlinkert/parse-authors) +## Contributing -## Run tests +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/parse-git-config/issues/new). -Install dev dependencies: +## Building docs -```bash -npm i -d && npm test +Generate readme and API documentation with [verb](https://github.com/verbose/verb): + +```sh +$ npm install verb && npm run docs ``` -## Contributing +Or, if [verb](https://github.com/verbose/verb) is installed globally: -Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/parse-git-config/issues) +```sh +$ verb +``` + +## Running tests + +Install dev dependencies: + +```sh +$ npm install -d && npm test +``` ## Author **Jon Schlinkert** -[github/jonschlinkert](https://github.com/jonschlinkert) -[twitter/jonschlinkert](http://twitter.com/jonschlinkert) +* [github/jonschlinkert](https://github.com/jonschlinkert) +* [twitter/jonschlinkert](http://twitter.com/jonschlinkert) ## License -Copyright (c) 2015 Jon Schlinkert -Released under the MIT license. +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-cli](https://github.com/assemble/verb-cli) on April 29, 2015._ - - +_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on February 26, 2016._ \ No newline at end of file diff --git a/package.json b/package.json index 8d730de..0f8ae63 100644 --- a/package.json +++ b/package.json @@ -23,6 +23,7 @@ "ini": "^1.3.3" }, "devDependencies": { + "gulp-format-md": "^0.1.7", "mocha": "*", "should": "*" }, @@ -32,6 +33,15 @@ "parse" ], "verb": { + "run": true, + "toc": false, + "layout": "default", + "tasks": [ + "readme" + ], + "plugins": [ + "gulp-format-md" + ], "related": { "list": [ "parse-github-url", @@ -39,6 +49,12 @@ "parse-author", "parse-authors" ] + }, + "reflinks": [ + "verb" + ], + "lint": { + "reflinks": true } } -} +} \ No newline at end of file