From 740ec191f72c2f99f5066d736fd3668ae42c9398 Mon Sep 17 00:00:00 2001 From: zepatrik Date: Fri, 30 Aug 2024 09:10:32 +0200 Subject: [PATCH] docs: add README for locales --- src/locales/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 src/locales/README.md diff --git a/src/locales/README.md b/src/locales/README.md new file mode 100644 index 000000000..cbe17fdcf --- /dev/null +++ b/src/locales/README.md @@ -0,0 +1,24 @@ +# Ory Elements Default Translations + +This directory contains the default translations for Ory Elements. These +translations are also used in the Ory Cloud Account Experience. Missing +translations automatically fall back to the English version. + +## Automation + +The English base language file is auto-generated from various sources. Please +update it by running `npm run generate-locales`. + +## Contributing + +If you want to contribute to the translations, please open a PR with the new or +updated translations. We appreciate your help! + +Please use formal language and avoid slang or colloquialisms. This ensures that +the translations are suitable for all use-cases. + +## Customizing Translations + +For details on how to use custom translations with your Ory Elements based +custom UI, please refer to the [README.md](../../README.md#internalization-i18n) +in the root of this repository.