handlebars-i18n 1.6.2 → 1.6.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "handlebars-i18n",
-  "version": "1.6.2",
-  "description": "handlebars-i18n adds internationlization to handlebars.js using i18next and Intl",
+  "version": "1.6.4",
+  "description": "handlebars-i18n adds internationalization to handlebars.js using i18next and Intl",
   "main": "dist/handlebars-i18n.js",
   "scripts": {
     "test": "nyc mocha",
@@ -17,16 +17,15 @@
     "url": "https://github.com/aller-couleur/handlebars-i18n.git"
   },
   "keywords": [
-    "handlebars-i18n",
+    "Translation",
+    "Multi-language",
     "Internationalization",
     "Localization",
     "Globalization",
-    "Translation",
     "Date Formatting",
     "Currency Formatting",
     "Number Formatting",
     "Handlebars",
-    "Handlebars.js",
     "i18next",
     "i18n",
     "Intl",

package/readme.md

@@ -1,8 +1,8 @@
 # handlebars-i18n
 
-`handlebars-i18n` adds the internationalization features of [i18next](https://www.i18next.com/) to [handlebars.js](https://handlebarsjs.com/). It also provides **date**, **number**, and **currency formatting** via [Intl](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl). Use as node module or in the web browser.
+`handlebars-i18n` adds the internationalization features of [i18next](https://www.i18next.com/) to [handlebars.js](https://handlebarsjs.com/). It also provides **date**, **number**, and **currency formatting** via [Intl](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl). Use as node module or in the web browser. Supports Typescript.
 
-Handlebars-i18n is listed amongst i18next’s [framework helpers](https://www.i18next.com/overview/supported-frameworks). Now supports Typescript thanks to [@DiefBell](https://github.com/DiefBell).
+Handlebars-i18n is listed amongst i18next’s [framework helpers](https://www.i18next.com/overview/supported-frameworks).
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 ![Node.js Version](https://img.shields.io/badge/Node.js-14.x-green)
@@ -10,14 +10,19 @@ Handlebars-i18n is listed amongst i18next’s [framework helpers](https://www.i1
 [![Coverage Status](https://coveralls.io/repos/github/fwalzel/handlebars-i18next/badge.svg?branch=master)](https://coveralls.io/github/fwalzel/handlebars-i18next?branch=master)
 [![Code Climate](https://codeclimate.com/github/Aller-Couleur/handlebars-i18n/badges/gpa.svg)](https://codeclimate.com/github/Aller-Couleur/handlebars-i18n)
 [![Known Vulnerabilities](https://snyk.io/test/github/Aller-Couleur/handlebars-i18n/badge.svg)](https://snyk.io/test/github/Aller-Couleur/handlebars-i18n/badge.svg)
+![npm](https://img.shields.io/npm/dt/handlebars-i18n)
 ![npm](https://img.shields.io/npm/dm/handlebars-i18n)
 
-
 ## License
 
-Copyright (c) 2020 Florian Walzel,
+Copyright (c) 2020–24 Florian Walzel,
+
 MIT License
 
+If you use handlebars-i18n in a professional context, you could
+
+[![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/fwalzel)
+
 ## Install
 
 If you use version npm >= 7:
@@ -117,43 +122,48 @@ Finally use in template:
 ```
 <p> {{__ "phrase1"}} </p>
 ```
+
 * returns for "en" &#x2192; **What is good?**
 
 ```
 <p> {{__ "phrase2" thing=myItem}} </p>
 ```
+
 * returns for "en" &#x2192; **handlebars-i18n is good.**
 
 ```
 <p> {{_date myDate}} </p>
 ```
+
 * returns for "en" &#x2192; **March 11, 2020, 4:24 AM**
 
 ```
 <p> {{_price myPrice}} </p>
 ```
+
 * returns for "en" &#x2192; **$1,200.99**
 
 ## Further examples
 
 :point_right: See the *examples folder* in the repo for more use cases and details.
 
+- Open `examples/browser-example/index.html` in your Web browser to see an implementation with a simple UI
+- Run `$ npm run example:js` in the console to get a very basic node example logged
+- Run `$ npm run example:ts` to compile and log a typescript example
 
-## NEW! :star_struck: Additional CLI Helper for Handlebars-i18n
+## Additional CLI Helper for Handlebars-i18n available :metal:
 
-Handlebars-i18n has its own command line interface [handlebars-i18n-cli](https://www.npmjs.com/package/handlebars-i18n-cli) by now.
+Handlebars-i18n has its own command line interface [handlebars-i18n-cli](https://www.npmjs.com/package/handlebars-i18n-cli).
 
 ```bash
 $ npm i handlebars-i18n-cli --save-dev
 ```
 
 Automatically extract translation strings from handlebars templates and generate i18next conform json files from it.
-Handlebars-i18n-cli also helps to keep your translations up to date when changes are made in the templates over time.
-
+Handlebars-i18n-cli also helps to keep[](https://) your translations up to date when changes are made in the templates over time.
 
 ## API
 
-
 ### __
 
 Returns the phrase associated with the given key for the selected language. __ will take all options i18next’s [t-function](https://www.i18next.com/overview/api#t) would take.
@@ -162,6 +172,7 @@ The primary key can be passed hard encoded in the template when written in quote
 ```
 {{__ "keyToTranslationPhrase"}}
 ```
+
 … or it can be referenced via a handlebars variable:
 
 ```
@@ -211,8 +222,6 @@ Will output the contents for "**de**" even though other language is selected.
 
 ---
 
-
-
 ### _locale
 
 Returns the shortcode of i18next’s currently selected language such as "**en**", "**de**", "**fr**", "**fi**" … etc.
@@ -220,6 +229,7 @@ Returns the shortcode of i18next’s currently selected language such as "**en**
 ```
 {{_locale}}
 ```
+
 ---
 
 ### localeIs
@@ -229,6 +239,7 @@ Checks a string against i18next’s currently selected language. Returns **true*
 ```
 {{#if (localeIs "en")}} ... {{/if}}
 ```
+
 ---
 
 ### _date
@@ -272,6 +283,7 @@ You can add multiple arguments for individual formatting. See [Intl DateTimeForm
 ```
 {{_date 1583922952743 year="2-digit" day="2-digit" timeZone="America/Los_Angeles"}}
 ```
+
 ---
 
 ### _num
@@ -289,6 +301,7 @@ You can add multiple arguments for individual formatting. See [Intl NumberFormat
 ```
 {{_num 3.14159 maximumFractionDigits=2}}
 ```
+
 Will output **3.14** for "**en**", but **3,14** for "**de**".
 
 ---
@@ -297,7 +310,6 @@ Will output **3.14** for "**en**", but **3,14** for "**de**".
 
 Outputs a formatted currency string according to the language specific conventions of price representation, e.g. **€9,999.99** for "**en**", but **9.999,99 €** for "**de**".
 
-
 ```
 {{_price 9999.99}}
 ```
@@ -417,4 +429,4 @@ For your contribution, I would like to thank [@MickL](https://github.com/MickL),
 
 ## Note
 
-There is a *different* package named [handlebars-i18next](https://www.npmjs.com/package/handlebars-i18next) by [Julian Gonggrijp](https://github.com/jgonggrijp) which might also suit your needs. Cheers!
+There is a *different* package named [handlebars-i18next](https://www.npmjs.com/package/handlebars-i18next) by [@jgonggrijp](https://github.com/jgonggrijp) which might also suit your needs. Cheers!