BadgesGenerator
Make badges

For developers

GitHub & Markdown Badge Generator

Create a badge for your repository or GitHub profile, choose its text and colors, and copy the Markdown or HTML straight into your README.

Build a static badge

Preview your badge as you change the text and colors, then copy the format your README uses.
Color
Previewbuild: passing

Badge previews load from shields.io, which receives your IP address and the badge text you enter.

Markdown
![build: passing](https://img.shields.io/badge/build-passing-brightgreen?logo=githubactions&logoColor=white)
HTML
<img alt="build: passing" src="https://img.shields.io/badge/build-passing-brightgreen?logo=githubactions&amp;logoColor=white">
Image URL
https://img.shields.io/badge/build-passing-brightgreen?logo=githubactions&logoColor=white

Ready-made README badges

Enter your repository or package details to fill badge snippets for build status, licenses, versions, downloads and social counts.

Badge previews load from shields.io, which receives your IP address and the badge text you enter.

  • Build status

    Add your repository or package to preview

    GitHub Actions workflow status for one branch, linked to the Actions tab.

    Build status Markdown
    [![CI](https://img.shields.io/github/actions/workflow/status/OWNER/REPO/ci.yml?branch=main)](https://github.com/OWNER/REPO/actions)

  • License

    Add your repository or package to preview

    The license GitHub detects in the repository, linked to the license file.

    License Markdown
    [![License](https://img.shields.io/github/license/OWNER/REPO)](https://github.com/OWNER/REPO/blob/main/LICENSE)

  • GitHub release

    Add your repository or package to preview

    The latest published release tag.

    GitHub release Markdown
    [![Release](https://img.shields.io/github/v/release/OWNER/REPO)](https://github.com/OWNER/REPO/releases)

  • npm version

    Add your repository or package to preview

    The current version of a package on npm.

    npm version Markdown
    [![npm](https://img.shields.io/npm/v/PACKAGE)](https://www.npmjs.com/package/PACKAGE)

  • PyPI version

    Add your repository or package to preview

    The current version of a package on PyPI.

    PyPI version Markdown
    [![PyPI](https://img.shields.io/pypi/v/PACKAGE)](https://pypi.org/project/PACKAGE/)

  • npm downloads

    Add your repository or package to preview

    Monthly downloads for an npm package.

    npm downloads Markdown
    [![Downloads](https://img.shields.io/npm/dm/PACKAGE)](https://www.npmjs.com/package/PACKAGE)

  • GitHub stars

    Add your repository or package to preview

    Star count in the social style, linked to the stargazers list.

    GitHub stars Markdown
    [![GitHub stars](https://img.shields.io/github/stars/OWNER/REPO?style=social)](https://github.com/OWNER/REPO/stargazers)

  • Followers

    Add your repository or package to preview

    Follower count for a GitHub profile README.

    Followers Markdown
    [![Followers](https://img.shields.io/github/followers/USER?style=social)](https://github.com/USER)

  • Static tech badge

    Static tech badge badge preview

    A fixed badge with a logo, popular for listing languages and tools on a profile.

    Static tech badge Markdown
    ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)

Create badges for your repository

Show your build status, package version, license or project links with shields.io badges that fit your README. Enter the repository or package details, choose a style and copy the badge code without creating an account.

What README badges are

README badges are the small status images in a row at the top of many repositories. Each one is an image wrapped in a link: the image comes from a badge service such as shields.io, and clicking it opens something related, like your CI runs, license file or package page. Static badges show fixed text you choose, such as a license name or a tool you use. Dynamic badges read live data from GitHub, npm, PyPI and other services whenever the image is requested, so a version or build badge stays current without editing the README. Images on GitHub pass through caches, so a fresh release can take a little while to show up.

Common badges: build, license, version and social

Build status badges show whether your GitHub Actions workflow is passing; point them at the workflow file, such as ci.yml, and a branch. License badges read the license GitHub detects in your repository. Version badges come in several flavors: the latest GitHub release, the npm version or the PyPI version of a package. Download badges show package installs over a period, such as npm downloads per month. Social badges use the social style to show GitHub stars or followers with a count bubble. For anything else, a static badge takes a label, a message and a color, and a logo parameter adds an icon from the Simple Icons set, for example logo=typescript.

How to add badges to a GitHub README

Copy the generated Markdown, paste it into your README.md file, then preview and save the file on GitHub. Markdown works anywhere GitHub renders Markdown, including issues, wikis and profile READMEs. Choose HTML when you need something Markdown can't do: centering a row of badges inside a paragraph with align set to center, setting an image height, or putting badges in a table cell. GitHub removes style attributes and scripts from README HTML, so plain a, img and p tags with align are the reliable building blocks. Both formats load the same shields.io image address, so you can switch formats later without touching the badge itself.

README badge questions

What happened to the original BadgesGenerator.com README tool?

The README badge generator is available on this page, where you can still create shields.io badge code and copy it into your repository or profile without an account.

How do I add a GitHub Actions build badge to my README?

Use the workflow status badge with your owner name, repository and workflow file name, for example ci.yml, and add a branch parameter such as branch=main so the badge follows that branch. Link it to the repository's Actions tab so visitors can open the runs. GitHub also offers its own badge image on each workflow's page if you prefer that version.

Why does my shields.io badge show an old number or an error?

Dynamic badges are cached by shields.io and by GitHub's image proxy, so a new release or star count can take a while to appear. If the badge says something like not found or invalid instead, check that the owner, repository, workflow file or package name in the address exactly matches the real one, then reload the page after a few minutes.

Can I use these badges on my GitHub profile page?

A profile README lives in a public repository named exactly like your username, and its README.md appears at the top of your profile. Many developers fill it with static badges for languages and tools, each with a logo parameter, plus a followers badge in the social style. Paste the Markdown from this page straight into that file.

How do I center a row of badges in a README?

Markdown has no centering option, so wrap the badges in HTML: a paragraph with align set to center, holding one link and image pair per badge, separated by spaces so they sit side by side. GitHub strips style attributes from README HTML, which is why the align attribute works there when CSS does not.

Need name badges for a meetup or conference?

Make name badges for your next meetup by adding your guest list to a template and printing the finished sheets for free.

Try the free name badge maker