stringify-github-url

0.1.0 • Public • Published

stringify-github-url NPM version

Generate a GitHub URL from an object.

Install with npm

npm i stringify-github-url --save

Usage

var github = require('stringify-github-url');

github

Stringify a GitHub project URL.

  • user {String}: Github user or org.
  • repo {String}: Project name
  • branch {String}: Optionally specify a branch.
  • returns: {String}

Example

github('assemble', 'verb');
//=> 'https://github.com/assemble/verb'
 
github('assemble', 'verb', 'v0.6.0');
//=> 'https://github.com/assemble/verb/tree/v0.6.0'

.tarball

Stringify a github tarball URL.

  • user {String}: The github user or org.
  • repo {String}: The repository
  • branch {String}: Branch, defaults to master.
  • returns: {String}

Example

github.tarball('assemble', 'verb');
//=> 'https://api.github.com/repos/assemble/verb/tarball'

.zipball

Stringify a github zipball URL.

  • user {String}: The github user or org.
  • repo {String}: The repository
  • branch {String}: Branch, defaults to master.
  • returns: {String}

Example

github.zipball('assemble', 'verb');
//=> 'https://api.github.com/repos/assemble/verb/zipball'

Related projects

Running tests

Install dev dependencies.

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license


This file was generated by verb-cli on March 14, 2015.

Readme

Keywords

none

Package Sidebar

Install

npm i stringify-github-url

Weekly Downloads

94

Version

0.1.0

License

MIT

Last publish

Collaborators

  • jonschlinkert