# github-url

> turn a repository: package.json field to a github url

Latest version **1.2.0** (published 2015-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-url
pnpm add github-url
yarn add github-url
bun add github-url
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2015-06-06 |
| First published | 2013-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Dominic Tarr |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/github-url
- Repository: https://github.com/dominictarr/github-url
- Issues: https://github.com/dominictarr/github-url/issues
- npm.io page: https://npm.io/package/github-url

## Recent versions

- 1.2.0 (latest) — 2015-06-06
- 1.1.0 — 2014-01-31
- 1.0.0 — 2013-03-15

## README

# github-url

parse the username, repo and protocol from a github clone url.

## Example


``` js
var parse = require('github-url')

console.log(parse('https://github.com/dominictarr/rumours.git'))

// ==> {user: 'dominictarr', project: 'rumours', protocol: 'https'}
```

if you want to parse a url from a service other than github,
you may pass in the expected host as the second argument to `parse`.
`parse(url, "gitlab.com")` for example.

## License

MIT

---
_Source: https://npm.io/package/github-url · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
