From bd83ee0b993fce93df89c44b4dc04d98a4bbacd0 Mon Sep 17 00:00:00 2001 From: jonschlinkert Date: Fri, 8 Dec 2017 10:16:07 -0500 Subject: [PATCH] run verb to generate readme --- README.md | 77 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 47 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 3561a3a..0cb4527 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -# parse-github-url [![NPM version](https://img.shields.io/npm/v/parse-github-url.svg?style=flat)](https://www.npmjs.com/package/parse-github-url) [![NPM monthly downloads](https://img.shields.io/npm/dm/parse-github-url.svg?style=flat)](https://npmjs.org/package/parse-github-url) [![NPM total downloads](https://img.shields.io/npm/dt/parse-github-url.svg?style=flat)](https://npmjs.org/package/parse-github-url) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/parse-github-url.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/parse-github-url) +# parse-github-url [![NPM version](https://img.shields.io/npm/v/parse-github-url.svg?style=flat)](https://www.npmjs.com/package/parse-github-url) [![NPM monthly downloads](https://img.shields.io/npm/dm/parse-github-url.svg?style=flat)](https://npmjs.org/package/parse-github-url) [![NPM total downloads](https://img.shields.io/npm/dt/parse-github-url.svg?style=flat)](https://npmjs.org/package/parse-github-url) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/parse-github-url.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/parse-github-url) > Parse a github URL into an object. +Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. + ## Install Install with [npm](https://www.npmjs.com/): @@ -256,7 +258,7 @@ Url { protocol: null, slashes: null, auth: null, - host: 'github.com', + host: 'gh.pages.com', port: null, hostname: null, hash: null, @@ -771,57 +773,72 @@ To be more consistent with node.js/package.json conventions, the following prope ## About -### Related projects +
+Contributing -* [github-short-url-regex](https://www.npmjs.com/package/github-short-url-regex): Regular expression (Regex) for matching github shorthand (user/repo#branch). | [homepage](https://github.com/regexps/github-short-url-regex "Regular expression (Regex) for matching github shorthand (user/repo#branch).") -* [is-git-url](https://www.npmjs.com/package/is-git-url): Regex to validate that a URL is a git url. | [homepage](https://github.com/jonschlinkert/is-git-url "Regex to validate that a URL is a git url.") -* [parse-github-short-url](https://www.npmjs.com/package/parse-github-short-url): Parse a github/npm shorthand (user/repo#branch or user/repo@version) URL into an object. | [homepage](https://github.com/tunnckocore/parse-github-short-url#readme "Parse a github/npm shorthand (user/repo#branch or user/repo@version) URL into an object.") +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). -### Contributing +
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). +
+Running Tests -### Contributors +Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: -| **Commits** | **Contributor** | -| --- | --- | -| 16 | [jonschlinkert](https://github.com/jonschlinkert) | -| 4 | [doowb](https://github.com/doowb) | -| 3 | [adjohnson916](https://github.com/adjohnson916) | -| 2 | [alferov](https://github.com/alferov) | -| 1 | [jeremyruppel](https://github.com/jeremyruppel) | -| 1 | [willbar](https://github.com/willbar) | +```sh +$ npm install && npm test +``` -### Building docs +
+
+Building docs -_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_ +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ -To generate the readme and API documentation with [verb](https://github.com/verbose/verb): +To generate the readme, run the following command: ```sh -$ npm install -g verb verb-generate-readme && verb +$ npm install -g verbose/verb#dev verb-generate-readme && verb ``` -### Running tests +
-Install dev dependencies: +### Related projects -```sh -$ npm install -d && npm test -``` +You might also be interested in these projects: + +* [git-add-remote](https://www.npmjs.com/package/git-add-remote): API for adding git remotes. | [homepage](https://github.com/jonschlinkert/git-add-remote "API for adding git remotes.") +* [git-branch](https://www.npmjs.com/package/git-branch): Get the current branch for a local git repository. | [homepage](https://github.com/jonschlinkert/git-branch "Get the current branch for a local git repository.") +* [git-repo-name](https://www.npmjs.com/package/git-repo-name): Get the repository name from the git remote origin URL. | [homepage](https://github.com/jonschlinkert/git-repo-name "Get the repository name from the git remote origin URL.") +* [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 "Get the username from a git remote origin URL.") +* [is-git-url](https://www.npmjs.com/package/is-git-url): Regex to validate that a URL is a git url. | [homepage](https://github.com/jonschlinkert/is-git-url "Regex to validate that a URL is a git url.") + +### Contributors + +| **Commits** | **Contributor** | +| --- | --- | +| 25 | [jonschlinkert](https://github.com/jonschlinkert) | +| 4 | [doowb](https://github.com/doowb) | +| 2 | [alferov](https://github.com/alferov) | +| 1 | [jmendiara](https://github.com/jmendiara) | +| 1 | [jeremyruppel](https://github.com/jeremyruppel) | +| 1 | [CookPete](https://github.com/CookPete) | +| 1 | [iamwillbar](https://github.com/iamwillbar) | +| 1 | [bmeiri](https://github.com/bmeiri) | ### Author **Jon Schlinkert** +* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert) * [github/jonschlinkert](https://github.com/jonschlinkert) -* [twitter/jonschlinkert](http://twitter.com/jonschlinkert) +* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ### License -Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). -Released under the [MIT license](LICENSE). +Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.1, on December 31, 2016._ \ 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 December 08, 2017._ \ No newline at end of file