]> gerrit.simantics Code Review - simantics/district.git/blob - README.md
9adbee0ea38635de28ade53338eb877aab59e827
[simantics/district.git] / README.md
1 [![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)
2 [![Dependency Status](https://gemnasium.com/robertkowalski/github-url-from-username-repo.png)](https://gemnasium.com/robertkowalski/github-url-from-username-repo)
3
4
5 # github-url-from-username-repo
6
7 ## API
8
9 ### getUrl(url, [forBrowser])
10
11 Get's the url normalized for npm.
12 If `forBrowser` is true, return a GitHub url that is usable in a webbrowser.
13
14 ## Usage
15
16 ```javascript
17
18 var getUrl = require("github-url-from-username-repo")
19 getUrl("visionmedia/express") // https://github.com/visionmedia/express
20
21 ```