badge-it

Github action to automatically add shield badges to your README.md :zap:

A Github action to add badges in your README.md without any hassle. We love badges but generially it's a tedious job to copy paste badges from shield.io to your README.md .So this Action helps to add badges without you having to do all the copy pasting and configuration.

DEMO REPO

Usage

Badges - To add your preffered badge, check it's correspoding key in the Availabe Badges section below and add the key in the badges input seperated by commas (,).
Badge Style - To specifiy style for your badges .Add your preffered badge style in the badge-style input. Default is flat.

- name: Add Badges
  uses: rocktimsaikia/badge-it@master
  with:
    GITHUB_TOKEN: ${{ secrets.MY_TOKEN }}
    badges: 'gh_license, gh_version, gh_stars'
    badge-style: 'flat-square'

Inputs

GITHUB_TOKEN - A personal Github token.
badges - Name of the badges to add to your README.
badge-style - The style type for your badges.

Available Badges

Keys are enclosed in brackets ()

- Github license (gh_license)
- Package.json version (gh_version)
- Stars (gh_stars)
- Fork counts (gh_fork)
- Followers counts (gh_followers)
- Open issues (gh_open_issues)
- Closed issues (gh_closed_issues)
- open pull requests (gh_open_pr)
- All dependecnies (gh_dependencies)
- Repo Size (gh_repo_size)
- Code Size (gh_code_size)
- TravisCI.com (travis_com)
- TravisCI.org key(travis_org)

Todo

There are many more badges that can be added here. If you want to contribute open a issue to discuss before hand. Currenly this action accepts only specifically Github related badges. But badges for CI services can also be added here. Thats could a be seperate issue on itself.

node-encoder - Encode and decode base64 based strings.

rocktimsaikia / badge-it

readme