Skip to content

Latest commit

 

History

History
130 lines (89 loc) · 16.3 KB

README.md

File metadata and controls

130 lines (89 loc) · 16.3 KB

AutoBadge

Interactive . Smart . Efficient

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

npm

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?! 😎

How to use?

Install it globally :

Run npm install -g autobadge and autobadge, that'S it ⚡

Supports

  • MarkDown
  • HTML
  • Shields Badges

Style

  • Flat
  • Flat-Square
  • Plastic
  • Social
  • For-The-Badge

What's New in 1.3.1?

  • Clickable badge when in HTML format
  • 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> License

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> Followers
<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> Forks
<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> Stars
<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> Watchers
<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> Twitter Follow

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> Repo Size

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> Github Issues
<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> Github closed Issues
<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> Github open PRs
<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> Github closed PRs

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> Language Count
<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> Top Language

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> Commits/month
<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> Last Commit
<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> Last release date
<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> Contributors

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> Release Version

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> GitHub Workflow Status

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> Hit Count

My Other Works

qikQR : Minimal Cross-Platform QR Code Generator Desktop App

Autopy-Lot: Github Action To Convert Jupyter Notebook To Python Script

MIT (c) 2020 Dipankar Pal