Skip to main content

Add a progress badge to your README

Publish a small "localized with transglot" image showing how many languages your project ships in.

Publish a small "localized with transglot" image showing how many languages your project ships in.

Who this is for

Owners and admins: it is a project setting, and it makes one fact about the project public.

Before you start

Understand exactly what becomes public: the badge shows the project name and the number of target languages. Nothing else: no strings, no translations, no other project.

Steps

  1. Turn the badge on for the project.

  2. Embed the project's badge image URL in your README or site.

What happens next

The badge renders wherever you embedded it, and updates as you add languages. It is cached hard, so a change may take a little while to show through an image proxy such as the one GitHub uses.

If it doesn't work

  • If the badge does not load, check it is switched on for the project. A project with the badge off is indistinguishable from one that does not exist. That is deliberate, so nobody can probe for private project names.

Related

  • Your project

  • The CDN

Did this answer your question?