{"_id":"readme-badger","_rev":"411007","name":"readme-badger","description":"Inserts badges into GitHub READMEs","dist-tags":{"latest":"0.3.0"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"time":{"modified":"2021-08-04T05:08:30.000Z","created":"2015-01-26T19:44:15.982Z","0.3.0":"2018-04-17T05:49:16.549Z","0.2.0":"2017-06-06T07:07:53.937Z","0.1.2":"2015-02-27T14:58:25.748Z","0.1.1":"2015-02-20T14:01:12.242Z","0.1.0":"2015-01-27T10:29:29.464Z","0.0.1":"2015-01-26T19:44:15.982Z"},"users":{},"author":{"name":"Andy Trevorah"},"repository":{"type":"git","url":"git+https://github.com/gitterHQ/readme-badger.git"},"versions":{"0.3.0":{"name":"readme-badger","version":"0.3.0","description":"Inserts badges into GitHub READMEs","main":"index.js","directories":{"test":"test"},"scripts":{"test":"mocha test/**/*.js"},"repository":{"type":"git","url":"git+https://github.com/gitterHQ/readme-badger.git"},"keywords":["badge","badger","github","readme"],"author":{"name":"Andy Trevorah"},"license":"MIT","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"homepage":"https://github.com/gitterHQ/readme-badger","devDependencies":{"mocha":"1.20.1"},"dependencies":{"balanced-match":"^1.0.0"},"gitHead":"fb03fe08a270b3f26a5313824d4244f209bb4f87","_id":"readme-badger@0.3.0","_npmVersion":"5.8.0","_nodeVersion":"6.14.1","_npmUser":{"name":"mlm","email":"contact@ericeastwood.com"},"dist":{"shasum":"87007f3c3e0c445e545134a305d8e3068fe9cd6e","size":5765,"noattachment":false,"key":"/readme-badger/-/readme-badger-0.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/readme-badger/download/readme-badger-0.3.0.tgz"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readme-badger_0.3.0_1523944156438_0.16444501900321007"},"_hasShrinkwrap":false,"publish_time":1523944156549,"_cnpm_publish_time":1523944156549},"0.2.0":{"name":"readme-badger","version":"0.2.0","description":"Inserts badges into GitHub READMEs","main":"index.js","directories":{"test":"test"},"scripts":{"test":"mocha test/**/*.js"},"repository":{"type":"git","url":"git+https://github.com/gitterHQ/readme-badger.git"},"keywords":["badge","badger","github","readme"],"author":{"name":"Andy Trevorah"},"license":"MIT","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"homepage":"https://github.com/gitterHQ/readme-badger","devDependencies":{"mocha":"1.20.1"},"gitHead":"d8b1534b2348edcf558d2856430bb867f2ed272a","_id":"readme-badger@0.2.0","_shasum":"1fdb448248fb5d40d8856fbd269dd8b927d1aff8","_from":".","_npmVersion":"2.15.11","_nodeVersion":"6.8.1","_npmUser":{"name":"mlm","email":"contact@ericeastwood.com"},"dist":{"shasum":"1fdb448248fb5d40d8856fbd269dd8b927d1aff8","size":4697,"noattachment":false,"key":"/readme-badger/-/readme-badger-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/readme-badger/download/readme-badger-0.2.0.tgz"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readme-badger-0.2.0.tgz_1496732873033_0.07510168571025133"},"publish_time":1496732873937,"_hasShrinkwrap":false,"_cnpm_publish_time":1496732873937},"0.1.2":{"name":"readme-badger","version":"0.1.2","description":"Inserts badges into GitHub READMEs","main":"index.js","directories":{"test":"test"},"scripts":{"test":"mocha test/**"},"repository":{"type":"git","url":"https://github.com/gitterHQ/readme-badger.git"},"keywords":["badge","badger","github","readme"],"author":{"name":"Andy Trevorah"},"license":"MIT","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"homepage":"https://github.com/gitterHQ/readme-badger","devDependencies":{"mocha":"1.20.1"},"gitHead":"a94e50cd06afd9b7f332c207b035a62bf635a498","_id":"readme-badger@0.1.2","_shasum":"81b138df9723c733df6a27c7bd9caebd383e08a5","_from":".","_npmVersion":"2.1.6","_nodeVersion":"0.10.33","_npmUser":{"name":"trevorah","email":"a.trevorah@gmail.com"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"dist":{"shasum":"81b138df9723c733df6a27c7bd9caebd383e08a5","size":4784,"noattachment":false,"key":"/readme-badger/-/readme-badger-0.1.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/readme-badger/download/readme-badger-0.1.2.tgz"},"publish_time":1425049105748,"_cnpm_publish_time":1425049105748,"_hasShrinkwrap":false},"0.1.1":{"name":"readme-badger","version":"0.1.1","description":"Inserts badges into GitHub READMEs","main":"index.js","directories":{"test":"test"},"scripts":{"test":"mocha test/**"},"repository":{"type":"git","url":"https://github.com/gitterHQ/readme-badger.git"},"keywords":["badge","badger","github","readme"],"author":{"name":"Andy Trevorah"},"license":"MIT","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"homepage":"https://github.com/gitterHQ/readme-badger","devDependencies":{"mocha":"1.20.1"},"gitHead":"2dd827b5944f257dbef07facc134d610f4ca75af","_id":"readme-badger@0.1.1","_shasum":"37c93309092c52bc25fc6e676cd16ce725de2b3a","_from":".","_npmVersion":"2.1.6","_nodeVersion":"0.10.33","_npmUser":{"name":"trevorah","email":"a.trevorah@gmail.com"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"dist":{"shasum":"37c93309092c52bc25fc6e676cd16ce725de2b3a","size":4768,"noattachment":false,"key":"/readme-badger/-/readme-badger-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/readme-badger/download/readme-badger-0.1.1.tgz"},"publish_time":1424440872242,"_cnpm_publish_time":1424440872242,"_hasShrinkwrap":false},"0.1.0":{"name":"readme-badger","version":"0.1.0","description":"Inserts badges into GitHub READMEs","main":"index.js","directories":{"test":"test"},"scripts":{"test":"mocha test"},"repository":{"type":"git","url":"https://github.com/gitterHQ/readme-badger.git"},"keywords":["badge","badger","github","readme"],"author":{"name":"Andy Trevorah"},"license":"MIT","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"homepage":"https://github.com/gitterHQ/readme-badger","devDependencies":{"mocha":"1.20.1"},"gitHead":"21e68267fe4c53b0ca2b81117b8152d153d92cae","_id":"readme-badger@0.1.0","_shasum":"7fdcd325f941c04d4b69d2231a2aac11601985c3","_from":".","_npmVersion":"2.1.6","_nodeVersion":"0.10.33","_npmUser":{"name":"trevorah","email":"a.trevorah@gmail.com"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"dist":{"shasum":"7fdcd325f941c04d4b69d2231a2aac11601985c3","size":4246,"noattachment":false,"key":"/readme-badger/-/readme-badger-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/readme-badger/download/readme-badger-0.1.0.tgz"},"publish_time":1422354569464,"_cnpm_publish_time":1422354569464,"_hasShrinkwrap":false},"0.0.1":{"name":"readme-badger","version":"0.0.1","description":"Inserts badges into GitHub READMEs","main":"index.js","directories":{"test":"test"},"scripts":{"test":"mocha test"},"repository":{"type":"git","url":"https://github.com/gitterHQ/readme-badger.git"},"keywords":["badge","badger","github","readme"],"author":{"name":"Andy Trevorah"},"license":"MIT","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"homepage":"https://github.com/gitterHQ/readme-badger","devDependencies":{"mocha":"1.20.1"},"gitHead":"3695cee255f487b4729014058e669f1f70778f06","_id":"readme-badger@0.0.1","_shasum":"3da85125c64ce17b4c75730cb36454b6a82af2b2","_from":".","_npmVersion":"2.1.6","_nodeVersion":"0.10.33","_npmUser":{"name":"trevorah","email":"a.trevorah@gmail.com"},"maintainers":[{"name":"mlm","email":"contact@ericeastwood.com"}],"dist":{"shasum":"3da85125c64ce17b4c75730cb36454b6a82af2b2","size":3271,"noattachment":false,"key":"/readme-badger/-/readme-badger-0.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/readme-badger/download/readme-badger-0.0.1.tgz"},"publish_time":1422301455982,"_cnpm_publish_time":1422301455982,"_hasShrinkwrap":false}},"readme":"readme-badger\n=============\n\n[![Build Status](https://travis-ci.org/gitterHQ/readme-badger.svg?branch=master)](https://travis-ci.org/gitterHQ/readme-badger)\n\nWhizzy badges in your READMEs.\n\nInstall\n-------\n\n`npm install readme-badger`\n\nHow To Use\n----------\n\n### `addBadge(content, fileExt, imageUrl, linkUrl, altText)`\n\nReturns the content but with a new badge inserted.\n\n* `content`: the text content of a README.\n* `fileExt`: the file extension of the README (md, textile, rdoc etc).\n* `imageUrl`: the image url for the badge.\n* `linkUrl`: the url for the badge to link to.\n* `altText`: the alternative if images aren't visible. This will be used on its own for plaintext READMEs, so include a url in the text.\n\n### `hasImageSupport(fileExt)`\n\nReturns true/false depending on whether the format (`fileExt`) will render a badge image or just the altText.\n\n* `fileExt`: the file extension of the README (md, textile, rdoc etc)\n\nExample\n-------\n```javascript\nvar badger = require('readme-badger');\n\nvar readme = '# My Lovely Library\\n' +\n             '\\n' +\n             '## Features\\n';\nvar imageUrl = 'https://badges.gitter.im/Join%20Chat.svg';\nvar linkUrl = 'https://gitter.im/gitterHQ/gitter';\nvar altText = 'Join the chat at https://gitter.im/gitterHQ/gitter';\n\nvar readmeWithBadge = badger.addBadge(readme, 'md', imageUrl, linkUrl, altText);\n\nconsole.log(readmeWithBadge);\n// # My Lovely Library\n//\n// [![Join the chat at https://gitter.im/gitterHQ/gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gitterHQ/gitter)\n//\n// ## Features\n// ...\n\n```\n\nFormat (`fileExt`) Support\n--------------\n\nreadme-badger supports almost all of the [GitHub README markups](https://github.com/github/markup#markups):\n* [markdown, mdown, mkdn, md](http://daringfireball.net/projects/markdown/)\n* [textile](http://www.textism.com/tools/textile/)\n* [rdoc](http://rdoc.sourceforge.net/)\n* [org](http://orgmode.org/)\n* [mediawiki, wiki](http://www.mediawiki.org/wiki/Help:Formatting)\n* [rst](http://docutils.sourceforge.net/rst.html)\n* [asciidoc, adoc, asc](http://asciidoc.org/)\n* [pod](http://search.cpan.org/dist/perl/pod/perlpod.pod)\n\nIt will also failover to inserting the `altText` at the bottom of the README for any format that doesnt have image link support (creole, txt or anything else).\n\nBuilding Locally\n----------------\n\n1. `git clone git@github.com:gitterHQ/readme-badger.git`\n2. `cd readme-badger`\n3. `npm install`\n4. `npm test`\n\nLicense\n-------\n\nMIT\n","_attachments":{},"homepage":"https://github.com/gitterHQ/readme-badger","bugs":{"url":"https://github.com/gitterHQ/readme-badger/issues"},"license":"MIT"}