Badge it- A Github Action to automate the process of adding Badges to your Readme.

Hi, Myself Rocktim and this is my submission for Actionshackathon.

My Workflow

What is Badge-it?

Badge-it is a simple GitHub action that automates the process of adding the Badges to your projects Readme ⚡ We all love to add badges to our GitHub projects to decorate it in a way so that the project does not look dull.

But the process of adding badges every time you create a GitHub project can be quite tedious. From all the copy-pasting to configuring your github_username and repo_name. And that's what I tried to solve with Badge-it. It saves you the time of configuring and adding badges
yourself manually.

Submission Category:

I am submitting this action under the following categories.

Interesting IoT
Wacky Wildcards)

Yaml File or Link to Code

Usage

The action takes 3 inputs.

A Github token
A string of badges separated by commas(,)

A base style for your badges.

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

Bagde-it Repo

rocktimsaikia / badge-it

Github action to automatically add badges to your readme ⚡

badge-it

Name: Badge it- A Github Action to automate the process of adding Badges to your Readme.
Rating: 1.5 (4193 reviews)
Author: rocktimsaikia

Github action to automatically add shield badges to your README.md ⚡

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…

View on GitHub

Additional Resources / Info

Currently, there is no open-source project using this action. So in the meantime, I am linking a demo repository for demo purposes.

Thank you for taking the time and checking out badge-it. If you like the project don't forget to add a star ⚡ or if you want to contribute you are more then welcome. 🚀

Update 🚀 ⚡

newly added badges will be updated here