{"_id":"stringify-github-url","_rev":"222025","name":"stringify-github-url","description":"Generate a GitHub URL from an object.","dist-tags":{"latest":"0.1.0"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T15:40:32.000Z","created":"2015-03-14T21:18:20.506Z","0.1.0":"2015-03-14T21:18:20.506Z"},"users":{},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/stringify-github-url.git"},"versions":{"0.1.0":{"name":"stringify-github-url","description":"Generate a GitHub URL from an object.","version":"0.1.0","homepage":"https://github.com/jonschlinkert/stringify-github-url","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/stringify-github-url.git"},"bugs":{"url":"https://github.com/jonschlinkert/stringify-github-url/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/stringify-github-url/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{},"devDependencies":{"mocha":"*","should":"*"},"keywords":[],"_id":"stringify-github-url@0.1.0","_shasum":"ab81fe9de5bf1c1496c23a42521d03f49aa62e8d","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"ab81fe9de5bf1c1496c23a42521d03f49aa62e8d","size":2469,"noattachment":false,"key":"/stringify-github-url/-/stringify-github-url-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/stringify-github-url/download/stringify-github-url-0.1.0.tgz"},"directories":{},"publish_time":1426367900506,"_cnpm_publish_time":1426367900506,"_hasShrinkwrap":false}},"readme":"# stringify-github-url [![NPM version](https://badge.fury.io/js/stringify-github-url.svg)](http://badge.fury.io/js/stringify-github-url)\n\n> Generate a GitHub URL from an object.\n\n## Install with [npm](npmjs.org)\n\n```bash\nnpm i stringify-github-url --save\n```\n\n## Usage\n\n```js\nvar github = require('stringify-github-url');\n```\n\n### [github](./index.js#L34)\n\nStringify a GitHub project URL.\n\n* `user` **{String}**: Github user or org.    \n* `repo` **{String}**: Project name    \n* `branch` **{String}**: Optionally specify a branch.    \n* `returns`: {String}  \n\n**Example**\n\n```js\ngithub('assemble', 'verb');\n//=> 'https://github.com/assemble/verb'\n\ngithub('assemble', 'verb', 'v0.6.0');\n//=> 'https://github.com/assemble/verb/tree/v0.6.0'\n```\n\n### [.tarball](./index.js#L78)\n\nStringify a github tarball URL.\n\n* `user` **{String}**: The github user or org.    \n* `repo` **{String}**: The repository    \n* `branch` **{String}**: Branch, defaults to `master`.    \n* `returns`: {String}  \n\n**Example**\n\n```js\ngithub.tarball('assemble', 'verb');\n//=> 'https://api.github.com/repos/assemble/verb/tarball'\n```\n\n### [.zipball](./index.js#L99)\n\nStringify a github zipball URL.\n\n* `user` **{String}**: The github user or org.    \n* `repo` **{String}**: The repository    \n* `branch` **{String}**: Branch, defaults to `master`.    \n* `returns`: {String}  \n\n**Example**\n\n```js\ngithub.zipball('assemble', 'verb');\n//=> 'https://api.github.com/repos/assemble/verb/zipball'\n```\n\n## Related projects\n* [is-git-url](https://github.com/jonschlinkert/is-git-url): Regex to validate that a URL is a git url.\n* [parse-github-url](https://github.com/jonschlinkert/parse-github-url): Parse a github URL into an object.  \n\n## Running tests\nInstall dev dependencies.\n\n```bash\nnpm i -d && npm test\n```\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/stringify-github-url/issues)\n\n## Author\n\n**Jon Schlinkert**\n \n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert) \n\n## License\nCopyright (c) 2015 Jon Schlinkert  \nReleased under the MIT license\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 14, 2015._","_attachments":{},"homepage":"https://github.com/jonschlinkert/stringify-github-url","bugs":{"url":"https://github.com/jonschlinkert/stringify-github-url/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/stringify-github-url/blob/master/LICENSE"}}