Skip to content

Instantly share code, notes, and snippets.

@rupeshtiwari
Last active November 20, 2023 15:31
Show Gist options
  • Star 7 You must be signed in to star a gist
  • Fork 2 You must be signed in to fork a gist
  • Save rupeshtiwari/8558ca0d8ec1c15619e4492dcd6aa81a to your computer and use it in GitHub Desktop.
Save rupeshtiwari/8558ca0d8ec1c15619e4492dcd6aa81a to your computer and use it in GitHub Desktop.
How to add your badge on readme files , nom, build, test result badges

How to add your own badge on README.md file

Here is a simple way to create your own badge for your npm package. I hope you will enjoy this.

Where to go and get badge

  • Go to https://shields.io/#/ website
  • prepare your own badge and
  • have these logo references in your readme files.

Alternative way to create badge

You can also follow this pattern https://img.shields.io/badge/[SUBJECT]-[STATUS]-[COLOR].svg and Put something on below values:

How to show images in Readme.MD files

below are the ways to show images in md files.

    ![npm package](https://img.shields.io/badge/npm%20package-v1-brightgreen.svg)

   ![build succeeded](https://img.shields.io/badge/build-succeeded-brightgreen.svg)

   ![Test passing](https://img.shields.io/badge/Tests-passing-brightgreen.svg)

see examples:

npm package

build succeeded

Test passing

Copy link

ghost commented Aug 26, 2021

my bot

Copy link

ghost commented Aug 26, 2021

my bot

@aljorhythm
Copy link

this is known as a badge, not a logo

@GiorgioSgl
Copy link

this is known as a badge, not a logo

Same, just loosing my time. Change title if you want correct people to visualize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment