diff options
Diffstat (limited to 'deps/npm/node_modules/github-url-from-username-repo/README.md')
| -rw-r--r-- | deps/npm/node_modules/github-url-from-username-repo/README.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/deps/npm/node_modules/github-url-from-username-repo/README.md b/deps/npm/node_modules/github-url-from-username-repo/README.md index 27c4054b26..9adbee0ea3 100644 --- a/deps/npm/node_modules/github-url-from-username-repo/README.md +++ b/deps/npm/node_modules/github-url-from-username-repo/README.md @@ -4,11 +4,18 @@ # 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") // git://github.com/visionmedia/express +getUrl("visionmedia/express") // https://github.com/visionmedia/express -```
\ No newline at end of file +``` |