A reference of several ready-made badges that you can implement in the Markdown code of your projects README.md
, and a guide of examples on how to customize them for your needs.
Badges help display relevant information visually and prominently, such as build status, test coverage, licenses, languages ββused, and more!
Tip
Contributions and suggestions are welcome! If you would like to contribute by adding new badges, feel free to open a PR. If you would like to request the addition of new badges, open an issue with your request.
To search for a specific badge among all those listed below press Ctrl + F
(or CMD + F
on macOS) and a search box
will open in your browser.
It is possible to use different styles in badges through query parameters of the powerful Shields.io API, see the examples below.
style
: (optional) The style of the badge. One of:flat
(default)flat-square
social
plastic
for-the-badge
Possibilities:
It is possible to create a personalized badge with a different logo, just search for the name of a logo available on the Simple Icons website, it even suggests the color of that brand, see the example:
Brand | Color | Badge | URL |
---|---|---|---|
VSCodium | #2F80ED | https://img.shields.io/badge/VSCodium-2F80ED?style=flat&logo=VSCodium&logoColor=white |
You can change the characteristics of your badges according to your needs. For example, see the Markdown badge below:
In the first example, we have the badge logo and text in white and a black background, while in the second case the opposite occurs when we change the background color in the URL from #000000
to #ffffff
and the logo color from white
to black
. Now we have a badge with customized colors π¨.
Below are lists of badges that are commonly used on the README pages of many projects. Badges are used to signal things like package version, status, activity, licenses, and more. Pay attention to the URL content to see which parts to change for your use case.
Tip
The badges listed here are dynamic, that is, you define them in your repository and as the data they illustrate is updated, whenever a visitor sees your README they will see the updated version of the badge π‘.
In the examples below, when the period or interval parameter is required, the possible values ββare [dd
, dw
, dm
, dy
, d18m
], which correspond respectively to daily, weekly, monthly downloads, year or 18 months.
The powerfull Shields.io API is used to generate the badges.