Add translation file example

lnmunhoz · Mar 31, 2020 · 9cf4967 · 9cf4967
1 parent 83d9244
commit 9cf4967
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,21 @@ Keep in mind this project is experimental, It assumes that you have a very speci
 yarn add -D i18n-codegen
 ```
 
+### Assumptions
+
+In this early stage, this package assume you have your translations in a JSON file using nested format.
+
+#### Example `en_US.json`
+
+```json
+{
+  "home": {
+    "title": "Title",
+    "subtitle": "Subtitle"
+  }
+}
+```
+
 ### Create a config file `i18nrc.js` in the root of the project.
 
 ```js