README Badge Generator
This README badge shows your app's name and current version and links to its About page in AboutTheApp. The version updates itself whenever you record a new one, so the README doesn't show an old number.
Preview
[](https://aboutthe.app/aboutthe.app)<a href="https://aboutthe.app/aboutthe.app"><img src="https://aboutthe.app/badge/aboutthe.app" alt="AboutTheApp" height="20"></a>What the badge shows
The badge shows the product name and the version an anonymous visitor would see. That's the product's current version or, with a customer alias, the version of that customer's primary deployment. Private versions are never shown.
The badge is cached for 5 minutes and GitHub keeps its own copy of README images, so a new version can take a few minutes to appear. An unknown alias shows a not found badge instead of a broken image.
Keep the version up to date
Create a free product in AboutTheApp, copy the Markdown with your alias and paste it at the top of README.md. Record new versions in the dashboard or from your release workflow, for example with the AboutTheApp GitHub Action.
GitHub Actions integrationFrequently asked questions
How do I add a version badge to a GitHub README?
Paste the Markdown from the generator into README.md. The image comes from aboutthe.app/badge/your-alias and always shows the version currently recorded in AboutTheApp.
Where does the badge get the version from?
From the product in AboutTheApp. Record each version in the dashboard or from your CI/CD pipeline and the badge shows it within a few minutes. The badge doesn't read the version from your repository.
Is the README badge free?
Yes. The badge works on every plan, including Free.
Create your product
The badge needs a product in AboutTheApp. The Free plan covers one app, including its About page, the About box and the badge.
Create a free account