diff --git a/packages/i18n/README.md b/packages/i18n/README.md index f8ad64372..ec443f6fc 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -36,6 +36,12 @@ const App = () => { }; ``` +## How the i18n workflow works? + +- When the `src/resources/en.json`(base language) updated and merged to the develop branch, will trigger the `languages-sync` action. +- The `languages-sync` action will check the base language and add missing translations to the Tolgee platform. +- This way, partners from the community can update the translations. + ## How to sync translations manually - Set token as environment variable @@ -45,7 +51,8 @@ export TOLGEE_API_KEY=tgpak_XXXXXXX ``` - Run the `sync-languages:check` to check all languages -- Run the `sync-languages` script to add new keys to the tolgee platform +- Run the `sync-languages` script to add new keys to the Tolgee platform +- Run the `download-resources` script to download the latest full-translation translation resources from the Tolgee platform ## References