{"_id":"github-contributors","_rev":"77764","name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","dist-tags":{"latest":"0.4.1"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T10:24:58.000Z","created":"2015-03-31T17:09:48.985Z","0.4.1":"2017-01-04T15:06:47.278Z","0.4.0":"2016-09-09T17:00:47.469Z","0.3.0":"2016-08-21T09:11:58.507Z","0.2.1":"2016-01-09T21:04:16.526Z","0.2.0":"2015-10-17T20:05:37.396Z","0.1.1":"2015-03-31T17:09:48.985Z"},"users":{},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/github-contributors.git"},"versions":{"0.4.1":{"name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","version":"0.4.1","homepage":"https://github.com/jonschlinkert/github-contributors","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/github-contributors.git"},"bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"format-people":"^0.1.4","github-base":"^0.5.1"},"devDependencies":{"data-store":"^0.16.1","extend-shallow":"^2.0.1","gulp-format-md":"^0.1.11","mocha":"^3.2.0"},"keywords":["contributors","github"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["get-pkgs","github-base"]},"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"bdc6542db382257c0f48211588e1351d65d91e34","_id":"github-contributors@0.4.1","_shasum":"2dd11977fef313617418fdd122e4a160ddcd91cd","_from":".","_npmVersion":"3.10.9","_nodeVersion":"6.9.2","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"2dd11977fef313617418fdd122e4a160ddcd91cd","size":3470,"noattachment":false,"key":"/github-contributors/-/github-contributors-0.4.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/github-contributors/download/github-contributors-0.4.1.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/github-contributors-0.4.1.tgz_1483542405580_0.08707355335354805"},"directories":{},"publish_time":1483542407278,"_cnpm_publish_time":1483542407278,"_hasShrinkwrap":false},"0.4.0":{"name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","version":"0.4.0","homepage":"https://github.com/jonschlinkert/github-contributors","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/github-contributors.git"},"bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"format-people":"^0.1.1","github-base":"^0.5.0"},"devDependencies":{"data-store":"^0.16.1","extend-shallow":"^2.0.1","gulp-format-md":"^0.1.10","mocha":"^3.0.2"},"keywords":["contributors","github"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["get-pkgs","github-base"]},"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"3fc455bbaef3ee05a0c05c059ed7679d479088f2","_id":"github-contributors@0.4.0","_shasum":"d5544de9a358b468e558a95ff2362ce14aa58dc6","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"d5544de9a358b468e558a95ff2362ce14aa58dc6","size":3416,"noattachment":false,"key":"/github-contributors/-/github-contributors-0.4.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/github-contributors/download/github-contributors-0.4.0.tgz"},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/github-contributors-0.4.0.tgz_1473440445935_0.9794230826664716"},"directories":{},"publish_time":1473440447469,"_cnpm_publish_time":1473440447469,"_hasShrinkwrap":false},"0.3.0":{"name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","version":"0.3.0","homepage":"https://github.com/jonschlinkert/github-contributors","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/github-contributors.git"},"bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":"MIT","files":["index.js","LICENSE","README.md"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"extend-shallow":"^2.0.1","github-base":"^0.4.1","markdown-utils":"^0.7.3","right-pad-values":"^0.3.1"},"devDependencies":{"gulp-format-md":"^0.1.10","mocha":"^3.0.2","should":"^11.1.0"},"keywords":["contributors","github"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"related":{"list":["get-pkgs","github-base"]},"lint":{"reflinks":true},"reflinks":["verb","verb-generate-readme"]},"gitHead":"267efd245cdb04a3ae0b06f98fd5012343ae3f69","_id":"github-contributors@0.3.0","_shasum":"8eff8fec83f5712d5bb757a49186eb5e048a5663","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"8eff8fec83f5712d5bb757a49186eb5e048a5663","size":3709,"noattachment":false,"key":"/github-contributors/-/github-contributors-0.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/github-contributors/download/github-contributors-0.3.0.tgz"},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/github-contributors-0.3.0.tgz_1471770717006_0.24325066013261676"},"directories":{},"publish_time":1471770718507,"_cnpm_publish_time":1471770718507,"_hasShrinkwrap":false},"0.2.1":{"name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","version":"0.2.1","homepage":"https://github.com/jonschlinkert/github-contributors","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/github-contributors.git"},"bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"github-base":"^0.4.0","markdown-utils":"^0.7.1","right-pad-values":"^0.3.1"},"devDependencies":{"gulp-format-md":"^0.1.5","mocha":"*","should":"*"},"keywords":["contributors","github"],"verb":{"related":{"list":["get-pkgs","github-base"]},"layout":"default","plugins":["gulp-format-md"]},"gitHead":"a3064f727d5e9c1dd2501f3e2dcad4f1059cfc4c","_id":"github-contributors@0.2.1","_shasum":"31b4e42018b2d8065297a0c0a8c2c27427c64538","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.3.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"31b4e42018b2d8065297a0c0a8c2c27427c64538","size":3483,"noattachment":false,"key":"/github-contributors/-/github-contributors-0.2.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/github-contributors/download/github-contributors-0.2.1.tgz"},"directories":{},"publish_time":1452373456526,"_cnpm_publish_time":1452373456526,"_hasShrinkwrap":false},"0.2.0":{"name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/github-contributors","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/github-contributors.git"},"bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/github-contributors/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"github-base":"^0.4.0","markdown-utils":"^0.7.1","right-pad-values":"^0.2.1"},"devDependencies":{"mocha":"*","should":"*"},"gitHead":"0013b026aafba23b9327945931dff8ee2c62b308","_id":"github-contributors@0.2.0","_shasum":"b187dfa59cf43fa171442d5c064d190c8363a082","_from":".","_npmVersion":"2.13.3","_nodeVersion":"0.12.0","_npmUser":{"name":"doowb","email":"brian.woodward@gmail.com"},"dist":{"shasum":"b187dfa59cf43fa171442d5c064d190c8363a082","size":3326,"noattachment":false,"key":"/github-contributors/-/github-contributors-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/github-contributors/download/github-contributors-0.2.0.tgz"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"directories":{},"publish_time":1445112337396,"_cnpm_publish_time":1445112337396,"_hasShrinkwrap":false},"0.1.1":{"name":"github-contributors","description":"Generate a markdown or JSON list of contributors for a project using the GitHub API.","version":"0.1.1","homepage":"https://github.com/jonschlinkert/github-contributors","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/github-contributors.git"},"bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/github-contributors/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"github-base":"^0.1.0","markdown-utils":"^0.6.0","right-pad-values":"^0.1.3"},"devDependencies":{"mocha":"*","should":"*"},"gitHead":"135a08e278c752806dba9bb5031bca55b7c56a9d","_id":"github-contributors@0.1.1","_shasum":"f2942ee0650df08f8f9b0c851b99c44c9a3cb441","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"f2942ee0650df08f8f9b0c851b99c44c9a3cb441","size":3268,"noattachment":false,"key":"/github-contributors/-/github-contributors-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/github-contributors/download/github-contributors-0.1.1.tgz"},"directories":{},"publish_time":1427821788985,"_cnpm_publish_time":1427821788985,"_hasShrinkwrap":false}},"readme":"# github-contributors [![NPM version](https://img.shields.io/npm/v/github-contributors.svg?style=flat)](https://www.npmjs.com/package/github-contributors) [![NPM downloads](https://img.shields.io/npm/dm/github-contributors.svg?style=flat)](https://npmjs.org/package/github-contributors) [![Build Status](https://img.shields.io/travis/jonschlinkert/github-contributors.svg?style=flat)](https://travis-ci.org/jonschlinkert/github-contributors)\n\n> Generate a markdown or JSON list of contributors for a project using the GitHub API.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save github-contributors\n```\n\n## Usage\n\n```js\nvar contributors = require('github-contributors');\nvar repo = 'assemble/assemble';\nvar opts = {};\n\ncontributors(repo, opts, function(err, res) {\n  if (err) console.log(err);\n  // do stuff with res\n});\n```\n\n### Contributors\n\nThe response is an array of contributor objects with this format:\n\n```js\n[{ login: 'doowb',\n    id: 995160,\n    avatar_url: 'https://avatars.githubusercontent.com/u/995160?v=3',\n    gravatar_id: '',\n    url: 'https://api.github.com/users/doowb',\n    html_url: 'https://github.com/doowb',\n    followers_url: 'https://api.github.com/users/doowb/followers',\n    following_url: 'https://api.github.com/users/doowb/following{/other_user}',\n    gists_url: 'https://api.github.com/users/doowb/gists{/gist_id}',\n    starred_url: 'https://api.github.com/users/doowb/starred{/owner}{/repo}',\n    subscriptions_url: 'https://api.github.com/users/doowb/subscriptions',\n    organizations_url: 'https://api.github.com/users/doowb/orgs',\n    repos_url: 'https://api.github.com/users/doowb/repos',\n    events_url: 'https://api.github.com/users/doowb/events{/privacy}',\n    received_events_url: 'https://api.github.com/users/doowb/received_events',\n    type: 'User',\n    site_admin: false,\n    contributions: 577 }]\n```\n\n## authentication\n\nYou can avoid hitting the GitHub rate limit by passing a client ID and client secret on the options:\n\n```js\nvar opts = {id: process.env.CLIENT_ID, secret: process.env.CLIENT_SECRET};\ncontributors('assemble/assemble', opts, function(err, res) {\n  if (err) console.log(err);\n  // do stuff with res\n});\n```\n\n## formatted list\n\nInstead of JSON, get a markdown-formatted list by defining one of the following on `options.format`\n\n* `list`\n* `aligned`\n* `table`\n\nHere are some examples.\n\n### list\n\nContributors from [jonschlinkert/micromatch](https://github.com/jonschlinkert/micromatch)\n\n**Commits** / **Contributor**\n\n* 253 [jonschlinkert](https://github.com/jonschlinkert)\n* 4   [es128](https://github.com/es128)\n* 1   [UltCombo](https://github.com/UltCombo)\n* 1   [tomByrer](https://github.com/tomByrer)\n\n### aligned list\n\nContributors from [jonschlinkert/gray-matter](https://github.com/jonschlinkert/gray-matter)\n\n```bash\nCOMMITS / CONTRIBUTOR\n------- | -----------\n107      jonschlinkert\n7        RobLoach\n2        doowb\n1        ianstormtaylor\n```\n\n### table\n\nContributors from [assemble/assemble](https://github.com/assemble/assemble)\n\n| **Commits** | **Contributor**<br/> | \n| --- | --- |\n| 949 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 577 | [doowb](https://github.com/doowb) |\n| 11 | [adjohnson916](https://github.com/adjohnson916) |\n| 7 | [Arkkimaagi](https://github.com/Arkkimaagi) |\n| 4 | [bendrucker](https://github.com/bendrucker) |\n| 2 | [avr](https://github.com/avr) |\n| 2 | [thegreatsunra](https://github.com/thegreatsunra) |\n| 2 | [StevenBlack](https://github.com/StevenBlack) |\n| 2 | [xzyfer](https://github.com/xzyfer) |\n| 2 | [ain](https://github.com/ain) |\n| 1 | [prettyboymp](https://github.com/prettyboymp) |\n| 1 | [asans](https://github.com/asans) |\n| 1 | [bauerca](https://github.com/bauerca) |\n| 1 | [jordanthomas](https://github.com/jordanthomas) |\n| 1 | [pburtchaell](https://github.com/pburtchaell) |\n| 1 | [oncletom](https://github.com/oncletom) |\n| 1 | [tomcode](https://github.com/tomcode) |\n| 1 | [tylerhowarth](https://github.com/tylerhowarth) |\n\n## About\n\n### Related projects\n\n* [get-pkgs](https://www.npmjs.com/package/get-pkgs): Get the package.json for an array of repos from the npm registry, optionally filtering properties… [more](https://github.com/jonschlinkert/get-pkgs) | [homepage](https://github.com/jonschlinkert/get-pkgs \"Get the package.json for an array of repos from the npm registry, optionally filtering properties using glob patterns.\")\n* [github-base](https://www.npmjs.com/package/github-base): JavaScript wrapper that greatly simplifies working with GitHub's API. | [homepage](https://github.com/jonschlinkert/github-base \"JavaScript wrapper that greatly simplifies working with GitHub's API.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\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\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/github-contributors/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on September 09, 2016._","_attachments":{},"homepage":"https://github.com/jonschlinkert/github-contributors","bugs":{"url":"https://github.com/jonschlinkert/github-contributors/issues"},"license":"MIT"}