From 4339ad316142eb91cb6c9b01d02092312c1f9841 Mon Sep 17 00:00:00 2001
From: Marcus Spiegel <spiegel@uscreen.de>
Date: Sun, 24 May 2020 17:27:48 +0200
Subject: [PATCH] Added example to README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index dc593349..e910ef4a 100644
--- a/README.md
+++ b/README.md
@@ -258,6 +258,28 @@ i18n.setLocale('de');
 __('Hello'); // --> Hallo`
 ```
 
+#### Some words on `staticCatalog` option
+
+Instead of letting i18n load translations from a given directory you may pass translations as static js object right on configuration. This supports any method that returns a `key:value` translation object (`{ Hello: 'Hallo', Cat: 'Katze' }`). So you might even mix native **json** with **js** modules and parsed **yaml** files, like so:
+
+```js
+// DEMO: quickly add yaml support
+const yaml = require('js-yaml');
+const fs   = require('fs');
+
+// configure and load translations from different locations
+i18n.configure({
+  staticCatalog: {
+    de: require('../../locales/de-as-json.json'),
+    en: require('../../locales/en-as-module.js'),
+    fr: yaml.safeLoad(fs.readFileSync('../../locales/fr-as-yaml.yml', 'utf8'));
+  },
+  defaultLocale: 'de'
+})
+```
+
+**NOTE:** Enabling `staticCatalog` disables all other fs realated options such as `updateFiles`,  `autoReload` and `syncFiles`
+
 ### i18n.init()
 
 When used as middleware in frameworks like express to setup the current environment for each loop. In contrast to configure the `i18n.init()` should be called within each request-response-cycle.