Skip to content
gohacks.dev
Tooling

README Badge Generator

Generate Markdown, HTML or reStructuredText for README badges: GitHub Actions status, package version and downloads on npm, Packagist or PyPI, license, stars and a custom static badge.

Free · No sign-up · Your inputs stay in your browser

Input

Generate README badges

Output

Badges

586 characters

The workflow badge is served by GitHub itself; the rest come from shields.io, which reads the registries live, so they update without editing the README. In a static badge, - and _ are separators, so a literal dash is written -- and an underscore __; this does that for you. Nothing is fetched here: the badge images load when the README is viewed.

Runs in this browser. Nothing you paste is sent to a server.

Live badges

Shields.io reads registries and GitHub when the badge is displayed, so versions and download counts update without editing the README. The workflow badge is served by GitHub from the latest run on the default branch. The static badge format is documented at shields.io.

Fewer is better

A row of twelve badges hides the one that matters. Build status, latest version and licence answer the questions a visitor has; the rest is decoration.

Share

Frequently asked questions

How do I show the build status for a specific branch?
Add ?branch=main to the workflow badge URL.
Why is my custom badge text broken?
In static badges, a dash separates label and message and an underscore means a space. Write -- for a literal dash and __ for an underscore.
Is what I paste sent anywhere?
No. The tool runs entirely in your browser with JavaScript. Nothing you type or paste is sent to our server or stored.

Keep planning

Similar tools