About github badge generator
Badges are small status images in a README, powered by shields.io. They show stars, licence, build status and more at a glance.
Common badges
- Stars, forks and issues.
- Licence and latest release.
- Build or test status from your CI.
Don't overdo it
A few meaningful badges help. A wall of badges is noise.
A worked example
A badge such as https://img.shields.io/github/license/owner/repo shows the project's licence. The generator builds the image URL and the Markdown to paste into a README, for example .
Which badges are useful
- Build status, so visitors see if the main branch passes tests.
- Latest version and downloads for packages.
- Licence, because many users check it before adopting a project.
Accessibility
Give each badge meaningful alt text, such as 'Build passing', so that screen reader users get the same information.
