i18n-lookup - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "i18n-lookup",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Utility node module for doing lookups from translation documents",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # i18n-lookup
 Utility node module for doing lookups from translation documents
+
+## Install
+
+```
+npm install [--save] i18n-lookup
+```
+
+## Usage
+
+A lookup function is returned by passing in the translation method as an argument. We normally use [i18next](https://www.npmjs.com/package/i18next).
+
+```javascript
+/**
+Locale: {
+    another: {
+        translation: {
+            key: 'Text'
+        }
+    }
+}
+**/
+var t = require('i18next').t;
+
+var lookup = require('i18n-lookup')(t);
+
+var translated = lookup([
+    'a.translation.key',
+    'another.translation.key'
+]);
+
+console.log(translated);
+// This will output the first key which has a corresponding translation defined.
+// => "Text"
+```
+
+Additionally, a template compilation method can be provided for cases where the translated key also includes template syntax.
+
+```javascript
+/**
+Locale: {
+    greeting: 'Hello {{name}}'
+}
+**/
+var t = require('i18next').t,
+    Mustache = require('mustachejs');
+
+var lookup = require('i18n-lookup')(t, Mustache.render);
+
+var translated = lookup([
+    'greeting'
+], {
+    name: 'John'
+});
+
+console.log(translated);
+// This will output the returned lookup compiled with the provided context
+// "Hello John"
+```

No alert changes

Improved metrics

Total package byte prevSize

4497

increased by33.01%

Number of lines in readme file

61

increased by1933.33%

No dependency changes