Skip to content

Share the localization progress of your app or project with your contributors, volunteers and translators, and attract more of them 😉

Notifications You must be signed in to change notification settings

localazy/shields

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 

Repository files navigation

Localazy Shields

Share the localization progress of your app or project publicly with your contributors, volunteers and translators. And get more of them 😉.

Example:

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: ![](https://connect.localazy.com/status/floating-apps?content=[value])

Value Demo Description
all The overal project progress and the number of langs.
progress The overal project progress.
langs The number of langs including text.
langs-count Only the number of langs.
locale code 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: ![](https://connect.localazy.com/status/floating-apps?title=[value])

Value Demo Description
default - Use lang-code for locale-specific shield, otherwise use localazy.
localazy
translated
localized
localization
translation
lang-loc-name The localized name.
lang-name The English name.
lang-code The locale code.

Logo

Add Localazy logo and optionally change its color.

Usage: ![](https://connect.localazy.com/status/floating-apps?logo=[true|RRGGBB])

Value Demo Description
true Just use the logo with the default white color.
RRGGBB Change the color if necessary. The color code is provided in HEX RRGGBB format.

Style

All styles from shields.io are supported.

Usage: ![](https://connect.localazy.com/status/floating-apps?style=[value])

Value Demo
plastic
flat
flat-square
for-the-badge
social

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

About

Share the localization progress of your app or project with your contributors, volunteers and translators, and attract more of them 😉

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published