README.md: Describe localized language translation code

Signed-off-by: Ralf Zerres <[email protected]>
IMI-eRnD-Be · Jun 12, 2021 · 037bb85 · 037bb85
1 parent 2caffa2
commit 037bb85
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,9 @@ fn main() {
 ```
 
 3.  You need an INI file with your translations. Example with `translations.ini`:
+    Language translations are matched by `two lowercase letter` code (eg: `en`).
+    Localized language translations are identified by `two lowercase letter` code,
+    plus `hyphen`, plus `to letter localization` code (eg: `en-gb`).
 
 ```
 [app_ruin_the_band]

diff --git a/src/lib.rs b/src/lib.rs
@@ -22,6 +22,9 @@
 //! ```
 //!
 //! 3.  You need an INI file with your translations. Example with `translations.ini`:
+//!     Language translations are matched by `two lowercase letter` code (eg: `en`).
+//!     Localized language translations are identified by `two lowercase letter` code,
+//!     plus `hyphen`, plus `to letter localization` code (eg: `en-gb`).
 //!
 //! ```text
 //! [app_ruin_the_band]