summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/github-url-from-username-repo/README.md
blob: 9adbee0ea38635de28ade53338eb877aab59e827 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
[![Build Status](https://travis-ci.org/robertkowalski/github-url-from-username-repo.png?branch=master)](https://travis-ci.org/robertkowalski/github-url-from-username-repo)
[![Dependency Status](https://gemnasium.com/robertkowalski/github-url-from-username-repo.png)](https://gemnasium.com/robertkowalski/github-url-from-username-repo)


# github-url-from-username-repo

## API

### getUrl(url, [forBrowser])

Get's the url normalized for npm.
If `forBrowser` is true, return a GitHub url that is usable in a webbrowser.

## Usage

```javascript

var getUrl = require("github-url-from-username-repo")
getUrl("visionmedia/express") // https://github.com/visionmedia/express

```