README Badge Generator

Enter a GitHub repo and get the Markdown for README badges — CI status, licence, stars, npm version and downloads — in one go.

Runs in your browser: input and output are never sent to the server, and the platform does not store your input.

Input

Not stored

Output

Fill in the fields on the left, then run.

How to use

  1. 1Enter the repo (owner/repo or a URL both work).
  2. 2Tick the badges you want and pick a style.
  3. 3Copy the Markdown and paste it under the title in README.md.

FAQ

The badge says “repo not found”?

shields.io can only read public repos. For a private repo's CI status, use GitHub's built-in workflow badge, which is visible to signed-in members.

The CI badge keeps showing “no status”?

The workflow must have run at least once, and the file name must match the one in .github/workflows.

Do badges update live?

Yes, but image caching at shields.io and GitHub can delay changes by a few minutes.

Is my input uploaded?

No. The Markdown is built in your browser; the badge images are later fetched from shields.io by whoever views the README.