https://github.com/localazy/shields
Share the localization progress of your app or project with your contributors, volunteers and translators, and attract more of them :wink:
https://github.com/localazy/shields
i18n internationalization l10n localization translation
Last synced: 5 months ago
JSON representation
Share the localization progress of your app or project with your contributors, volunteers and translators, and attract more of them :wink:
- Host: GitHub
- URL: https://github.com/localazy/shields
- Owner: localazy
- Created: 2020-10-07T12:11:49.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-21T07:32:52.000Z (about 4 years ago)
- Last Synced: 2025-08-17T20:51:02.338Z (5 months ago)
- Topics: i18n, internationalization, l10n, localization, translation
- Homepage: https://localazy.com
- Size: 18.6 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Localazy Shields
Share the localization progress of your app or project publicly with your contributors, volunteers and translators. And get more of them :wink:.
Example:
[](https://localazy.com/p/floating-apps)
## Format
The basic URL is:
`https://connect.localazy.com/status/[project-id]`
There are four parameters that allows you to override texts, look and feel:
- **content** - changes the generated information
- **title** - changes the informative title
- **style** - changes the style of the shield
- **logo** - adds logo and allow to colorize it
The full URL looks like:
`https://connect.localazy.com/status/[project-id]?title=...&content=...&style=...&logo=...`
## Content
You can use the shield to show overal project progress, number of languages or progress for defined language.
Usage: ``
| Value | Demo | Description |
| --- | --- | --- |
| all | [](https://localazy.com/p/floating-apps) | The overal project progress and the number of langs. |
| progress | [](https://localazy.com/p/floating-apps) | The overal project progress. |
| langs | [](https://localazy.com/p/floating-apps) | The number of langs including text. |
| langs-count | [](https://localazy.com/p/floating-apps) | Only the number of langs. |
| *locale code* | [](https://localazy.com/p/floating-apps) | The progress for the given language. The valid format for locale code is described below. |
## Title
You can change the shown title to one of the available variants. There are also specific variants for locale-specific shields.
Usage: ``
| Value | Demo | Description |
| --- | --- | --- |
| default | - | Use `lang-code` for locale-specific shield, otherwise use `localazy`. |
| localazy | [](https://localazy.com/p/floating-apps) | |
| translated | [](https://localazy.com/p/floating-apps) | |
| localized | [](https://localazy.com/p/floating-apps) | |
| localization | [](https://localazy.com/p/floating-apps) | |
| translation | [](https://localazy.com/p/floating-apps) | |
| lang-loc-name | [](https://localazy.com/p/floating-apps) | The localized name. |
| lang-name | [](https://localazy.com/p/floating-apps) | The English name. |
| lang-code | [](https://localazy.com/p/floating-apps) | The locale code. |
## Logo
Add Localazy logo and optionally change its color.
Usage: ``
| Value | Demo | Description |
| --- | --- | --- |
| true | [](https://localazy.com/p/floating-apps) | Just use the logo with the default white color. |
| RRGGBB | [](https://localazy.com/p/floating-apps) | Change the color if necessary. The color code is provided in HEX RRGGBB format. |
## Style
All styles from [shields.io](https://shields.io) are supported.
Usage: ``
| Value | Demo |
| --- | --- |
| plastic | [](https://localazy.com/p/floating-apps) |
| flat | [](https://localazy.com/p/floating-apps) |
| flat-square | [](https://localazy.com/p/floating-apps) |
| for-the-badge | [](https://localazy.com/p/floating-apps) |
| social | [](https://localazy.com/p/floating-apps) |
## Locale Code Format
Any of these formats is recognized as valid locale code:
* **ll**
* **ll_RR**
* **ll-RR**
* **ll+RR**
* **ll_Scrp**
* **ll-Scrp**
* **ll+Scrp**
* **ll#Scrp**
* **ll_RR_Scrp**
* **ll_Scrp_RR**
* **ll_RR#Scrp**
* **ll-RR-Scrp**
* **ll-Scrp-RR**
* **ll-RR#Scrp**
* **ll+RR+Scrp**
* **ll+Scrp+RR**
Where:
- **ll** is language code
- **RR** is region code
- **Scrp** is script code