UNPKG

autobadge

Version:

simple CLI tool to generate repository badges

131 lines (89 loc) 16.7 kB
<div align=center> <p align="center"><a href="https://github.com/deep5050/autobadge"><img src="https://i.imgur.com/Dk2OBJa.png" title="AutoBadge" height="190px" width="190px" /></a></p> <a href="https://github.com/deep5050/autobadge"><img src="https://i.imgur.com/vCKdWI5.png" title="autobadge" /></a> <p align="center"> <h1 align="center">AutoBadge</h1></p> <p align="center"><h2 align="center"> Interactive . Smart . Efficient</h2></p> <p align="center">A Simple Cli Tool To Generate Essential Repository Badges With Ease. It Asks For Minimum Information From The User And Produces All (Almost) The Essential Badges</p> <p align="center"><a href="https://github.com/deep5050/autobadge/actions?query=workflow%3Anpm-publish"><img src="https://img.shields.io/github/workflow/status/deep5050/autobadge/npm-publish?label=npm-publish&logo=github&style=for-the-badge"></a></p> <p align="center"><a href="https://www.npmjs.com/package/autobadge"><img alt="npm" src="https://img.shields.io/npm/dt/autobadge?color=red&label=INSTALL&logo=npm&style=for-the-badge"></a></p> </div> ## Why use? Digging The Internet For Getting Common Badges Is Not A Handy Way. Why Not Use A Script And Answer Few Questions To Generate Them? Huh?! :sunglasses: ## How to use? Install It Globally : Run `npm install -g autobadge` and `autobadge`, That'S It :zap: <p align="center"><a href="https://github.com/deep5050/autobadge"><img src="https://i.imgur.com/sL3yf7x.png" title="autobadge" /></a></p> ## Supports - [x] MarkDown - [x] HTML - [x] Shields Badges ## Style - [x] Flat - [x] Flat-Square - [x] Plastic - [x] Social - [x] For-The-Badge ## What's New in 1.3.1? - [x] Clickable Badge When In HTML Format - [x] Separate URLs For Each badges ## TODO - [ ] HTML Alignment Support - [ ] Ad Shields Badges - [ ] Badgen Badges - [ ] ForTheBadge Badges ## Result (More Coming Soon....) ## License Badges | Syntax | Badge | | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/deep5050/autobadge?style=for-the-badge"/></a> | ## Social Badges | Syntax | Badge | | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050?tab=followers"><img alt="Followers" src="https://img.shields.io/github/followers/deep5050?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050?tab=followers"><img alt="Followers" src="https://img.shields.io/github/followers/deep5050?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/network/members"><img alt="Forks" src="https://img.shields.io/github/forks/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/network/members"><img alt="Forks" src="https://img.shields.io/github/forks/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/watchers"><img alt="Watchers" src="https://img.shields.io/github/watchers/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/watchers"><img alt="Watchers" src="https://img.shields.io/github/watchers/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://twitter.com/dipankar5050"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/dipankar5050?logo=twitter&style=for-the-badge"/></a>` | <a href="https://twitter.com/dipankar5050"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/dipankar5050?logo=twitter&style=for-the-badge"/></a> | ## Size Badges | Syntax | Badge | | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge"><img alt="Repo Size" src="https://img.shields.io/github/repo-size/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge"><img alt="Repo Size" src="https://img.shields.io/github/repo-size/deep5050/autobadge?style=for-the-badge"/></a> | ## Issues Badges | Syntax | Badge | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge/issues"><img alt="Github Issues" src="https://img.shields.io/github/issues-raw/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/issues"><img alt="Github Issues" src="https://img.shields.io/github/issues-raw/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/issues?q=is%3Aissue+is%3Aclosed"><img alt="Github closed Issues" src="https://img.shields.io/github/issues-closed/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/issues?q=is%3Aissue+is%3Aclosed"><img alt="Github closed Issues" src="https://img.shields.io/github/issues-closed/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/pulls"><img alt="Github open PRs" src="https://img.shields.io/github/issues-pr-raw/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/pulls"><img alt="Github open PRs" src="https://img.shields.io/github/issues-pr-raw/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/pulls?q=is%3Apr+is%3Aclosed"><img alt="Github closed PRs" src="https://img.shields.io/github/issues-pr-closed/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/pulls?q=is%3Apr+is%3Aclosed"><img alt="Github closed PRs" src="https://img.shields.io/github/issues-pr-closed/deep5050/autobadge?style=for-the-badge"/></a> | ## Analysis Badges | Syntax | Badge | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge"><img alt="Language Count" src="https://img.shields.io/github/languages/count/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge"><img alt="Language Count" src="https://img.shields.io/github/languages/count/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge"><img alt="Top Language" src="https://img.shields.io/github/languages/top/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge"><img alt="Top Language" src="https://img.shields.io/github/languages/top/deep5050/autobadge?style=for-the-badge"/></a> | ## Activity Badges | Syntax | Badge | | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge/graphs/commit-activity"><img alt="Commits/month" src="https://img.shields.io/github/commit-activity/m/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/graphs/commit-activity"><img alt="Commits/month" src="https://img.shields.io/github/commit-activity/m/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/graphs/commit-activity"><img alt="Last Commit" src="https://img.shields.io/github/last-commit/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/graphs/commit-activity"><img alt="Last Commit" src="https://img.shields.io/github/last-commit/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/releases"><img alt="Last release date" src="https://img.shields.io/github/release-date/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/releases"><img alt="Last release date" src="https://img.shields.io/github/release-date/deep5050/autobadge?style=for-the-badge"/></a> | | `<a href="https://github.com/deep5050/autobadge/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/deep5050/autobadge?style=for-the-badge"/></a> | ## Version Badges | Syntax | Badge | | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge/releases"><img alt="Release Version" src="https://img.shields.io/github/v/release/deep5050/autobadge?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/releases"><img alt="Release Version" src="https://img.shields.io/github/v/release/deep5050/autobadge?style=for-the-badge"/></a> | ## CI/CD Badges | Syntax | Badge | | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge/actions?query=workflow:npm-publish"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/deep5050/autobadge/npm-publish?label=npm-publish&logo=github&style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge/actions?query=workflow:npm-publish"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/deep5050/autobadge/npm-publish?label=npm-publish&logo=github&style=for-the-badge"/></a> | ## Other Badges | Syntax | Badge | | :------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------: | | `<a href="https://github.com/deep5050/autobadge"><img alt="Hit Count" src="http://hits.dwyl.com/deep5050/autobadge.svg?style=for-the-badge"/></a>` | <a href="https://github.com/deep5050/autobadge"><img alt="Hit Count" src="http://hits.dwyl.com/deep5050/autobadge.svg?style=for-the-badge"/></a> | # My Other Works <a href="https://github.com/deep5050/qikQR">qikQR : Minimal Cross-Platform QR Code Generator Desktop App </a> <a href="https://github.com/deep5050/autopy-lot">Autopy-Lot: Github Action To Convert Jupyter Notebook To Python Script</a> ### MIT (c) 2020 Dipankar Pal