Something wrong with this tool?
About Readme Badges Generator Online
This tool builds Markdown badge snippets for your GitHub README (or any Markdown documentation). Badges visually show build status, code coverage, package version, license, downloads, social presence and more — making your project look polished and trustworthy.
Common badge types include shields.io style badges for libraries (npm version, downloads), CI status (GitHub Actions, CircleCI), code quality (Codecov, Coveralls), licensing (MIT, Apache-2.0), and project metadata (last commit, contributors).
Generated snippets are Markdown ready to paste at the top of your README. Most badges link to external services that update automatically — so once added, they keep showing live data without you needing to edit the file.
How to use this tool
How to generate README badges for an npm package
Enter the package name
"Package name" expects the exact npm package name as published — scoped packages like `@scope/name` work the same as unscoped `name`. Whitespace is trimmed automatically.
Press Run
Result returns a single `markdown` field with three shields.io image links: the latest published version, weekly download count, and the SPDX license. They're rendered side-by-side without line breaks.
Where the data comes from
Each badge is a shields.io URL that hits npm's registry endpoints at render time. They auto-update — you don't need to regenerate the badges when you publish a new version.
Customising the badges
Drop the markdown straight into your README's top section. Want different shields? Edit the generated URLs — shields.io supports `?color=blue`, `?style=flat-square`, `?logo=npm`, and many others. See shields.io for the full param reference.