README Badge Generator
Create copy-ready Markdown and HTML for a configurable project badge.
Build readable status badges for documentation
Project badges compress a label and current message into a small documentation image, often linked to a build, package, or coverage page. This generator encodes the label, message, color, optional Simple Icons logo, style, and click target into an img.shields.io badge URL, then provides both linked Markdown and equivalent HTML markup.
The defaults create a build badge showing passing in bright green, add the GitHub logo parameter, use the flat style, and link to the example actions page. Spaces, underscores, hyphens, and URL characters are encoded for badge-path rules, while the label and message become meaningful alternative text rather than a generic image description.
Encoding and external image behavior
The generated image URL points to Shields.io when rendered, although this page never fetches it. Repository viewers may cache badge images, and a static message does not verify the linked status by itself. Generation is local in your browser. Use truthful wording, keep contrast readable, and prefer a dynamic endpoint only when its source and availability are appropriate for the project.
Frequently Asked Questions
Does this page contact Shields.io?
No. It only generates the URL and markup; the badge service is contacted later wherever that image is rendered.
Why are hyphens and underscores encoded specially?
Shields badge path segments use doubled punctuation and underscores for spaces, so ordinary URL encoding alone is not enough.
Can the badge link to a build page?
Yes. Enter an absolute target URL and the Markdown and HTML output will wrap the badge in that link.
Browse the full set of free, private, in-browser tools.