README Badge Generator

Make shields.io badges for your README. Type a label and message, pick a color, style and logo, and copy the badge as Markdown, HTML or reStructuredText — dashes, underscores and spaces are escaped for you. Or choose a live badge that shows your npm version, GitHub stars, latest release, license or CI status. A preview shows exactly how it will look. It's free and builds the badge in your browser.

Escaping in static badges

You wantWrite in the URL
---
___
space_
%%25

When to use it

  1. Add build, version and license badges to a GitHub README.
  2. Show an npm package's version and monthly downloads.
  3. Display a GitHub Actions workflow status.
  4. Create custom badges like 'made with Rust' or 'PRs welcome'.

How to Use

  1. Choose a static badge or a live one.
  2. Enter the text or package/repo name.
  3. Pick the color, style and logo.
  4. Copy the Markdown or HTML into your README.

Features

  1. Static badges with correct escaping
  2. npm, GitHub, PyPI and crates.io live badges
  3. Five styles
  4. Simple Icons logos
  5. Markdown, HTML and reStructuredText
  6. Clickable badges

FAQs

How do I put a hyphen or space in a badge?

Write a hyphen as -- and a space as _ in the badge URL. The generator escapes them automatically.

How do I add a logo?

Enter a Simple Icons name such as github, npm, docker or python in the Logo field.

Can badges update automatically?

Yes — choose a dynamic badge such as npm version or GitHub stars and shields.io fetches the current value each time it's shown.

How do I make a badge clickable?

Add a link; the Markdown wraps the image in [ ](link).

Is anything uploaded?

The badge URL is built in your browser. The preview image is loaded from shields.io, as it would be in your README.

Technical Details

A static shields.io badge encodes its text in the URL path as label-message-color, which means the characters that separate those parts need escaping inside the text: a literal hyphen is written as a double hyphen, an underscore as a double underscore, and a space as a single underscore, after which the rest is percent-encoded. Getting that wrong produces a broken or mis-split badge, so the generator does it for you. Colors can be named (brightgreen, informational, critical) or hex, and query parameters add the style — flat, flat-square, plastic, for-the-badge or social — a logo from the Simple Icons set with its color, and a separate label color. Dynamic badges for npm versions and downloads, GitHub stars, releases, license and Actions workflow status, PyPI and crates.io are built from their documented endpoints. The output is ready-made Markdown (optionally wrapped in a link), HTML and reStructuredText. The preview image is loaded from shields.io, which renders the badge; everything else happens in your browser.

Developer Tools

Developer Tools

  • JSON to Zod
  • HTML Table Generator
  • Regex Cheatsheet
  • JSON to GraphQL
  • Regex Escape & Extract
  • AI Prompt Generator
  • Combine Files for AI
  • Freelance Rate Calculator