Add a progress badge to your README
Show how many languages your open-source project ships in, with a badge in its README.
The badge is a small image that shows your project's name and how many languages it is translated into, for example my-library | 12 languages. The count is the project's target languages; the source language is not counted. It updates on its own when you add or remove a language.
Open-source plan only
The badge is part of the open-source plan. When a workspace is granted the plan, the badge is switched on for the projects the workspace has at that point. There is no setting in the console to switch it on or off for a single project.
What the badge makes public
The badge shows exactly two things: the project's name and its number of target languages. It shows no strings, no translations, and nothing about your other projects.
Add the badge
Find your workspace and project slugs
They are in the console address of the project: https://app.transglot.ai/orgs/{workspace}/projects/{project}.
Build the badge address
https://api.transglot.ai/badge/{workspace}/{project}.svgOpen it in a browser to check it renders.
Add it to your README
[](https://transglot.ai)Caching
The badge is cached for five minutes and revalidated with an ETag. After you add a language, it can take a few minutes to show through an image proxy such as GitHub's.
If it doesn't work
- The badge returns
404. A project without the badge switched on returns the same404as a project that does not exist, so nobody can use the badge to discover private project names. Check the slugs in the address, and that the workspace is on the open-source plan. - The badge stopped working after a rename. The badge address uses the project's slug. Changing the project's URL in its settings breaks badges that use the old one; update the address in your README.
- The badge disappeared. If the open-source grant ends, the badge is switched off for the workspace's projects.