ES
Home › Developer Tools › README Badge Generator

README Badge Generator

Create the status badges that sit at the top of a GitHub README: license, npm version, CI build, coverage, downloads, stars or any custom label and color. Fill in your repository once, preview every style, and copy ready-made Markdown, HTML or reStructuredText.

Last updated:

Your project Used by the GitHub and npm badges.

Badges

Add:

Preview

Advertisement
Advertisement

How to use the README Badge Generator

  1. Enter your project: GitHub owner, repository, npm package name and CI workflow file.
  2. Add badges with the buttons, for example License, Build status or a Custom badge.
  3. Customize each badge: label, color, logo from Simple Icons and where it links to.
  4. Choose a style and check the preview; tick Load real badges to see the live values.
  5. Copy the code in Markdown, HTML or reStructuredText and paste it at the top of your README.

Shields.io URL patterns

BadgeURL path after https://img.shields.io/
Static (label, message, color)badge/build-passing-brightgreen
Static without a labelbadge/stable-blue
License from GitHubgithub/license/OWNER/REPO
npm versionnpm/v/PACKAGE
npm monthly downloadsnpm/dm/PACKAGE
GitHub Actions workflowgithub/actions/workflow/status/OWNER/REPO/ci.yml?branch=main
Codecov coveragecodecov/c/github/OWNER/REPO
GitHub stars / issues / last commitgithub/stars/OWNER/REPO, github/issues/OWNER/REPO, github/last-commit/OWNER/REPO

Every badge accepts the same query options: style, label, color, labelColor, logo and logoColor. For example ?style=for-the-badge&logo=github.

Tips for a tidy badge row

  • Keep it short. Three to six badges answer the questions visitors actually have: does it build, what version is it, what license is it under, is it maintained.
  • Put the most important badge first, usually the build or CI status.
  • Use one style for the whole row so the heights match.
  • Link every badge to the page that explains it: the workflow runs, the npm page or the LICENSE file.
  • Write meaningful alt text such as “build status” so screen readers and broken images still make sense.

Starting a README from scratch? The README Generator builds the rest of the file, and the License Generator creates the LICENSE your badge points to.

Frequently asked questions

How do README badges work?

A badge is just an image. Shields.io generates the SVG on request from the URL: a static badge encodes its label, message and color in the path, and a dynamic badge such as github/license/owner/repo looks up the current value from GitHub, npm or another service each time the README is viewed.

How do I write a dash, underscore or space in a static badge?

In a Shields.io static badge URL, dashes separate the label, message and color, so a literal dash is written as two dashes (--). An underscore or %20 means a space, so a literal underscore is written as two underscores (__). This generator applies these rules for you.

Which logos can I use?

Shields.io accepts the names of Simple Icons, such as github, npm, python, docker, javascript or githubactions. Type the name in lowercase without spaces. logoColor changes the icon color; the offline preview shows a placeholder where the icon will appear.

Why does my badge say "repo not found" or "invalid"?

Dynamic badges read live data, so the repository, package or workflow must exist and be public. Check the spelling of the owner, repository and package, and for build badges the exact workflow file name in .github/workflows, such as ci.yml.

What colors can I use?

Named colors (brightgreen, green, yellowgreen, yellow, orange, red, blue, lightgrey, grey, blueviolet), the semantic names success, important, critical, informational and inactive, or any hex code such as ff69b4. Leave a dynamic badge's color empty to use the color Shields.io chooses for the value.

Which badge style should I pick?

flat is the most common default. flat-square has square corners, for-the-badge is larger with uppercase text and suits project landing pages, plastic is the older glossy look, and social mimics GitHub's star and follow buttons. Use the same style for every badge in a row.

Is anything uploaded?

No. Badge code is built in your browser and the default preview is drawn locally. Only if you tick Load real badges does your browser request the badge images from img.shields.io, exactly as GitHub will when it shows your README.

Are all the tools on FreeToolCabin tested for quality and accuracy?

Yes! Every tool on our site undergoes automated Q/A testing in real browser environments to ensure high precision, correct output, and zero errors. If you happen to spot a bug or have a suggestion, please contact us at [email protected] and our team will review it right away.

Related tools

README GeneratorFill in a form and get a polished README.md with badges, install, usage and license, live preview.License GeneratorCreate a LICENSE file for MIT, Apache, GPL, BSD, ISC, MPL or Unlicense with your name and year.GitHub Actions Workflow GeneratorBuild a GitHub Actions CI workflow: triggers, matrix, caching, tests, Pages or Docker deploy.package.json GeneratorFill a form and get a valid, npm-ready package.json with scripts, dependencies and checks.QR Code GeneratorMake QR codes for links, Wi-Fi, email and more.Barcode GeneratorCreate Code 128, EAN-13, UPC-A, EAN-8, Code 39 and ITF-14 barcodes as PNG or SVG.UUID GeneratorGenerate UUID v4 and v7 / GUIDs in bulk and copy or download them.Schema Markup Generator (JSON-LD)Create JSON-LD structured data for FAQ, Product, Article and more.Htaccess & Nginx Redirect GeneratorBuild 301 redirects for .htaccess, Nginx and Netlify or Cloudflare _redirects.Fake Data GeneratorGenerate mock data as JSON, CSV or SQL.Random String GeneratorGenerate secure random strings and tokens in bulk with any length and character set.API Key GeneratorCreate secure API keys and secrets with prefixes, checksums and SHA-256 hashes for storage.MIME Type LookupFind the MIME type for any file extension, or the extensions for a MIME type, in 400+ entries.Cron Expression GeneratorBuild crontab schedules visually, read them in plain English and see the next run times.URL Slug GeneratorTurn titles into clean, SEO-friendly URL slugs: accents, stop words, separators and bulk lines.JSON Schema GeneratorTurn sample JSON into a draft 2020-12 JSON Schema with types, required fields and formats.Gitignore GeneratorBuild a .gitignore from 50+ templates for languages, frameworks, IDEs and OS, merged and deduped.ULID GeneratorGenerate sortable ULIDs and UUID v7 in bulk, monotonic option, and decode their timestamps.Htpasswd GeneratorCreate .htpasswd entries with bcrypt, APR1-MD5 or SHA-1 for Apache and Nginx basic auth.Placeholder Image GeneratorCreate placeholder images in any size, color and text as PNG, JPG, WebP, SVG or data URI.Ads.txt GeneratorCreate or validate ads.txt and app-ads.txt files: seller lines, cert IDs and variables.Docker Run to Compose ConverterConvert docker run commands to docker-compose.yml, or a compose file back to docker run.Dockerfile GeneratorGenerate a production Dockerfile and .dockerignore for Node, Python, Go or a static nginx site.HTML Boilerplate GeneratorTick the options you need and get a clean HTML5 starter template with meta, OG tags and CSS reset.JSON to Zod SchemaInfer a Zod (or Yup) schema from sample JSON with optional, nullable and z.infer types.Linux Commands Cheat SheetSearchable Linux and bash command reference with flags explained, examples and copy buttons.LLMs.txt GeneratorBuild an llms.txt file for AI crawlers: summary and link sections, import from your sitemap.Nano ID GeneratorGenerate secure Nano IDs with custom alphabet, length and count, plus a collision calculator.Nginx Config GeneratorBuild an nginx server block: static site, SPA, reverse proxy or PHP, with SSL, gzip and redirects.OpenAPI / Swagger ViewerView OpenAPI 2/3 JSON or YAML as interactive API docs with validation and an endpoint list.PKCE Code Challenge GeneratorGenerate an OAuth 2.0 PKCE code_verifier and S256 code_challenge, build auth URLs, verify pairs.Regex GeneratorBuild regular expressions visually from blocks or presets (email, date, phone) and test them live.Commit Message GeneratorBuild Conventional Commit messages with type, scope, body, breaking change and issue refs.Database Schema DesignerDesign tables and relationships visually, then export SQL for MySQL, PostgreSQL or SQLite.Docker Compose GeneratorBuild a docker-compose.yml with a form: services, ports, volumes, env, healthchecks and presets.Dummy File GeneratorCreate test files of an exact size in KB, MB or GB with zeros, random bytes or text.FFmpeg Command GeneratorPick a task and options, get the exact ffmpeg command with every flag explained.Folder Tree GeneratorTurn a local folder or an indented list into an ASCII directory tree for your README.cURL Command BuilderBuild curl commands from a form: method, headers, query, JSON or form body, auth and flags.Docker Compose to KubernetesConvert docker-compose.yml into Kubernetes Deployment, Service, ConfigMap and PVC manifests.Docker Compose ValidatorCheck a docker-compose.yml for YAML errors, schema mistakes, broken references and deprecated keys.Dockerfile LinterLint a Dockerfile for best practices: pinned tags, apt cleanup, non-root USER and layer count.Dockerignore GeneratorBuild a .dockerignore from Node, Python, Go and Java templates, plus your own entries.ESLint Config GeneratorGenerate a flat eslint.config.js for JavaScript, TypeScript, React or Node with rule presets.Git Branch Name GeneratorTurn a ticket ID and title into a clean, valid git branch name like feature/PROJ-12-add-login.GitLab CI Config GeneratorGenerate a .gitlab-ci.yml with stages, jobs, images, cache, artifacts and rules from templates.Jinja2 Template TesterRender Jinja2 templates with YAML or JSON variables using real Jinja2, with clear error lines.JSON Schema Mock Data GeneratorGenerate realistic sample JSON from a JSON Schema: formats, patterns, $ref, seeds and counts.Kubernetes Secret GeneratorCreate Kubernetes Secret YAML from key/value pairs or .env with auto base64, or decode one.Kubernetes YAML ValidatorValidate Kubernetes manifests against the API schema of a chosen version, with error paths.Prettier Config GeneratorToggle Prettier options, preview formatted code live and copy your .prettierrc file.Quartz Cron GeneratorBuild and explain Quartz and Spring cron expressions with seconds, ?, L, W and #, plus next fire times.Systemd Service File GeneratorCreate a systemd .service unit with ExecStart, user, restart policy, environment and hardening.tsconfig.json GeneratorBuild a tsconfig.json with target, module, strict checks and path aliases, each option explained.Access Log AnalyzerAnalyze Apache and Nginx access logs: top URLs, IPs, status codes, bots and traffic charts.Regex String GeneratorGenerate random test strings that match any regular expression, checked against the real regex.ASCII Table GeneratorTurn CSV or pasted cells into plain-text tables: MySQL, Markdown, Unicode box and reST styles.Kubernetes YAML GeneratorGenerate Deployment, Service, Ingress, ConfigMap, Secret and HPA manifests with safe defaults.Markdown TOC GeneratorGenerate a linked table of contents from Markdown headings with GitHub-style anchors.OpenAPI EditorEdit OpenAPI/Swagger YAML or JSON side by side with live API docs, validation and download.OpenAPI ValidatorValidate OpenAPI 3.0/3.1 and Swagger 2.0 specs: schema errors, broken $refs, line numbers.Pivot Table MakerBuild pivot tables from CSV or Excel by drag and drop: sum, count, average, charts, export.SQL Query BuilderBuild SELECT queries visually: joins, filters, GROUP BY, ORDER BY and LIMIT, as clean SQL.Truth Table GeneratorType a logic expression and get its full truth table, minterms and canonical DNF/CNF.TypeScript PlaygroundWrite TypeScript with live type checking, see the compiled JavaScript and run it in your browser.Article Schema GeneratorCreate Article, BlogPosting or NewsArticle JSON-LD with headline, authors, dates and images.Event Schema GeneratorCreate Event JSON-LD with dates, venue or online location, tickets, organizer and performers.Google Search Query BuilderBuild advanced Google searches with site:, filetype:, intitle:, exact phrases and date operators.
See all 85 Code Generators & Builders →