Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/technikhil314/auto-badger
Add status badges to your markdown in 2 seconds
https://github.com/technikhil314/auto-badger
auto-badger automation badgen badges badges-markdown cli npm shields shields-io
Last synced: 11 days ago
JSON representation
Add status badges to your markdown in 2 seconds
- Host: GitHub
- URL: https://github.com/technikhil314/auto-badger
- Owner: technikhil314
- License: mit
- Created: 2020-07-12T15:15:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T18:41:32.000Z (over 1 year ago)
- Last Synced: 2024-10-26T15:22:30.543Z (12 days ago)
- Topics: auto-badger, automation, badgen, badges, badges-markdown, cli, npm, shields, shields-io
- Language: JavaScript
- Homepage: https://technikhil314.netlify.app/autobadger
- Size: 638 KB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Git Auto badger
### Add badges to your project in 2 seconds
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)
[//]: <> (start placeholder for auto-badger)
[](https://github.com/technikhil314/auto-badger/actions)
[](https://npmjs.org/git-auto-badger)
[](https://packagephobia.com/result?p=git-auto-badger)
[](https://github.com/technikhil314/auto-badger/blob/master/LICENSE)
[](https://libraries.io/npm/git-auto-badger)
[](https://npmcharts.com/compare/git-auto-badger)
[](https://github.com/technikhil314/auto-badger/graphs/contributors)
[](https://github.com/technikhil314/auto-badger/blob/master/CODE_OF_CONDUCT.md)
[](https://gitter.im/auto-badger)
[](https://github.com/technikhil314/auto-badger/stargazers)
[](https://github.com/technikhil314/auto-badger/fork)
[](https://www.twitter.com/technikhil314)
###### :clap: & :heart: to [auto badger](https://github.com/technikhil314/auto-badger) for making badging simple
[//]: <> (end placeholder for auto-badger)
## Table of contents
- [Git Auto badger](#git-auto-badger)
- [Add badges to your project in 2 seconds](#add-badges-to-your-project-in-2-seconds)
- [:clap: & :heart: to auto badger for making badging simple](#clap--heart-to-auto-badger-for-making-badging-simple)
- [Table of contents](#table-of-contents)
- [Announcements](#announcements)
- [Prerequisites](#prerequisites)
- [See the demo running here](#see-the-demo-running-here)
- [Why](#why)
- [How to use](#how-to-use)
- [Install the cli](#install-the-cli)
- [Add placeholder to your markdown](#add-placeholder-to-your-markdown)
- [Run the cli](#run-the-cli)
- [What all things are supported](#what-all-things-are-supported)
- [How it works?](#how-it-works)
- [Defaults](#defaults)
- [If you liked my work, show some :heart: :star: the repo.](#if-you-liked-my-work-show-some-heart-star-the-repo)
- [Facing Problems](#facing-problems)
- [Contributions](#contributions)
- [How to contribute](#how-to-contribute)
## Announcements
- 06 Mar 2021
1. Added -e/--exclude option to opt out of some badges
- 08 Nov 2020
1. Added -p option for passing custom path to your markdown
- 01 Nov 2020
1. Using meow and update notifier
2. Removing accidentally added npm package. A total blunder :(
- 18 Oct 2020
1. Using find-up to search files. Now you can use this with monorepos too.
## Prerequisites
Node >= 10.x.x
## See the demo running here
[](https://raw.githubusercontent.com/technikhil314/my-static-assets/master/terminal-casts/auto-badger.svg)
## Why
1. Copy pasting / creating badges on [shields.io](https://shields.io/) such a robotic job.
2. Some of the default provided badges lacks of some of the accessibility constraint. White on green does not meet the required contrast ratio. See the badge below for example it will be difficult for low vision people to read it
[](https://github.com/technikhil314/angular-components/actions)
## How to use
### Install the cli
```
npm i -g git-auto-badger
or
yarn add -g git-auto-badger
```
### Add placeholder to your markdown
Add following markdown comment where you want the badges to appear
```
[//]: <> (start placeholder for auto-badger)
```
### Run the cli
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.
## What all things are supported
This cli currently supports following providers from each category
1. VCS
- [Github](https://www.github.com/) [:heavy_check_mark:]
- [Gitlab](https://www.gitlab.com/) [Coming soon]
1. CI/CD
- [Travis CI](https://travis-ci.org/) [:heavy_check_mark:]
- [Github Actions (first Job)](https://github.com/features/actions) [:heavy_check_mark:]
- [Appveyor](https://www.appveyor.com/) [:heavy_check_mark:]
- [Circle CI](https://circleci.com/) [:heavy_check_mark:]
1. Coverage
- [Coveralls](https://coveralls.io/) [:heavy_check_mark:]
- [CodeCov](https://codecov.io/) [:heavy_check_mark:]
1. Package Managers
- [NPM](https://www.npmjs.com/) [:heavy_check_mark:]
- [PyPI](https://pypi.org/) [Coming soon]
1. License
- Github License File [:heavy_check_mark:]
1. Code of Conduct
- Github CoC File [:heavy_check_mark:]
1. Dependancies
- [Libraries.io for NPM](https://libraries.io/) [:heavy_check_mark:]
1. Package size
- [Bundelphobia](https://bundlephobia.com/) [:heavy_check_mark:]
1. Download Count
- [NPM Per month](https://npmcharts.com/) [:heavy_check_mark:]
1. Social
- Github (Repo Stars, Fork) [:heavy_check_mark:]
- twitter (Follow user/org) [:heavy_check_mark:]
1. Chat
- [Gitter](https://gitter.im/) [:heavy_check_mark:]
- [Spectrum](https://spectrum.chat/) [:heavy_check_mark:]
- [Discord](https://discord.com/) [:heavy_check_mark:]
### How it works?
1. 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
### Defaults
| Badge Type | Default |
| ---------- | --------------------------------------------- |
| Size | Bundle phobia (if browser only package) |
| Size | package phobia (if node only package e.g cli) |
## If you liked my work, show some :heart: :star: the repo.
Also you can appreciate by
# Facing Problems
Please let me know if you are facing any issues [here](https://github.com/technikhil314/auto-badger/issues)
# Contributions
Would :heart: to see any contributions.
### How to contribute
1. Fork this repo
1. `cd auto-badger`
1. `npm link`
1. Make changes
1. `auto-badger`
1. Check and make sure all badges are generated properly