From 1e060474c70dd72615967de7a29139b547bbd93b Mon Sep 17 00:00:00 2001 From: Priscila Oliveira Date: Sun, 3 May 2020 08:21:59 +0200 Subject: [PATCH] ref(doc): updated translation section (#473) --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index fa36462..361fc89 100755 --- a/README.md +++ b/README.md @@ -105,6 +105,28 @@ If you have any issue you can try the following options, do no desist to ask or Translations are handled locally. I18n files can be found in the folder ```i18n/translations/*``` of this repository. We would love to provide translations from other languages, embracing all our users, but unfortunately we cannot do this without your help. Would you like to help us? Please feel **super welcome** to add a locale by opening a pull request. +Your PR should contain: + +1 - A json file in the folder ```i18n/translations/*``` with the translations. The file must be named according to the new added language + +2 - The files ```i18n/config.ts``` and ```LanguageSwitch.tsx``` updated with the new language. Please see the current structure + +3 - The other translations containing the new language in the language of the file. Example: + +New language: ```cs_CZ ``` + +The file ```pt-BR ``` should contain: + ``` + "lng": { + ..., + "cs_cz": "Tcheco" + } + ``` + +4 - A SVG flag of the new translated language in the the folder ```src/components/Icon/img/*```. You maybe want to compress the svg file using https://jakearchibald.github.io/svgomg/ + + + ### License Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)