Add status badges to your markdown in 2 seconds
MIT License
A npm cli tool that reads your packagejson/project metadata and git config and connects your readme with multiple badge providers (shields.io, badgen.net etc)
Node >= 10.x.x
npm i -g git-auto-badger
or
yarn add -g git-auto-badger
Add following markdown comment where you want the badges to appear
[//]: <> (start placeholder for auto-badger)
then run following in your project root directory
npx auto-badger
And whoo hoo you are done. All the necessary badges are added to your markdown.
This cli currently supports following providers from each category
It looks for different file in your project root directory. To decide what tools are you using. And generates badges based on it.
e.g. If you have .travis.yml then it assumes you are using travis for CI/CD and it creates a dynamic badge for travis latest build status or if you have appveyor.yml then it assumes you are using appveyor for CI/CD and it creates a dynamic badge for appveyor latest build status
Badge Type | Default |
---|---|
Size | Bundle phobia (if browser only package) |
Size | package phobia (if node only package e.g cli) |
Also you can appreciate by
Please let me know if you are facing any issues here
Would ❤️ to see any contributions.
cd auto-badger
npm link
auto-badger