badgify
v1.2.1
Published
Rebuild readme markdown badges from package.json scripts
Readme
Badgify
This package will generate stable links and markdown syntax for npm modules. In particular it outputs syntax for npm, travis, david, coveralls & stability badge svgs so you can easily paste them to your readme.
Usage
Install (with -g or npm link the install), and use in a package root:
$ badgifyExample output (from badgify folder):
[](https://www.npmjs.org/package/badgify)
[](http://travis-ci.org/clux/badgify)
[](https://david-dm.org/clux/badgify)
[](https://coveralls.io/r/clux/badgify)Then copy paste that to the start of your README.md. For speed you could pipe it through xclip, or just use it to generate a basic README:
echo "# $(basename $PWD)" > README.md
badgify >> README.mdHow
- Will generate npm badge using the package.json
namekey if the package is notprivate - If your repo has the
.travis.ymlfile it will generate a travis build badge - It will always generate the david-dm link for your dependencies
- If your
package.jsonhas acoverallsor acoveragescript it will generate the svg badge that links to your coveralls.io report - Stability badge can be provided if you set the
stabilitykey in package.json
License
MIT-Licensed. See LICENSE file for details.
