Build linked Markdown badges for workflow status, licence, npm version and downloads, with the hyphen and underscore escaping shields requires handled for you.
0 of 1 badges ready
This badge needs the owner and repository name.
Fill in what each badge needs and the Markdown appears here.
GitHub Actions workflow status: This badge needs the owner and repository name. Both come from the repository URL: github.com/<owner>/<repo>.
No request is made, so nothing here can tell you whether a badge will actually resolve — a workflow badge pointing at a file that does not exist renders as “no status” rather than failing visibly. In a custom badge a hyphen must be doubled and an underscore becomes a space, which is handled for you; it is the reason hand-written shields URLs so often show the wrong text.
README Badge Generator runs entirely on your device — nothing is uploaded.
You’re on the Free plan. Compare plans
Badges are a small thing that is annoying to get right, mostly because of shields.io's escaping rules. In a custom badge a hyphen has to be doubled and an underscore becomes a space, since single hyphens separate the three fields of the URL. `code-style` written literally produces a badge reading "code" followed by "style", which is the usual symptom of not knowing that.
The workflow badge uses GitHub's own endpoint rather than shields, because GitHub's reflects the real run status without a third party in the request path. It takes no style parameter, which is why the style control does nothing for that one — and the page says so rather than appending a parameter that is silently discarded.
Each badge is linked to the place a reader would want: the workflow badge to its runs, the version badge to the package page, the licence badge to the licence file. An unlinked badge is a picture of a fact; a linked one is a way to check it.
No request is made. The URLs are constructed rather than fetched, so nothing here can tell you whether a badge will resolve — a workflow badge pointing at a file that does not exist renders as "no status" rather than failing visibly, which is worth checking once after pasting.
Shields uses hyphens to separate the label, message and colour, so a hyphen inside your text has to be doubled and an underscore becomes a space. `code-style` must be written `code--style`. This tool does that escaping for you.
Because that one uses GitHub's own badge endpoint rather than shields, and it takes no style parameter. GitHub's reflects the real run status with no third party in the path, which is worth more than matching styles.
Nothing here fetches it, so this cannot say. A workflow badge for a file that does not exist renders as "no status" rather than an error, so it is worth looking at once after pasting.
Often not, especially for scoped packages. The version and download badges need the published package name, which is the `name` field in package.json.
Few. Badges at the top of a README compete with the sentence explaining what the project is, which is the thing a reader actually needs. Build status and licence earn their place; a row of twelve does not.