n2words 1.10.0 → 1.11.1

package/.eslintrc.json

@@ -6,6 +6,7 @@
     "es2017": true,
     "es2020": true,
     "es2021": true,
+    "es2022": true,
     "node": true
   },
   "plugins": [
@@ -26,7 +27,7 @@
     "files": ["*.js", "*.mjs"]
   }],
   "parserOptions": {
-    "ecmaVersion": 2021,
+    "ecmaVersion": "latest",
     "sourceType": "module"
   },
   "rules": {

package/CHANGELOG.md

@@ -5,6 +5,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [1.11.1] - 2022-04-08
+
+### Changed
+- Improve README [#67](https://github.com/forzagreen/n2words/pull/67) [#66](https://github.com/forzagreen/n2words/pull/66). Thanks to [@TylerVigario](https://github.com/TylerVigario) !
+- Update dev dependencies (Webpack, ESLint...) [#65](https://github.com/forzagreen/n2words/pull/65). Thanks to [@TylerVigario](https://github.com/TylerVigario) !
+
+
+## [1.11.0] - 2022-01-08
+
+### Added
+- New language: `hr` Croatian [#61](https://github.com/forzagreen/n2words/pull/61). Thanks to [@lagavuliner](https://github.com/lagavuliner) !
+
+### Fixed
+- Fix translations for Serbian [#60](https://github.com/forzagreen/n2words/pull/60) [#61](https://github.com/forzagreen/n2words/pull/61). Thanks to [@lagavuliner](https://github.com/lagavuliner) !
+
+
+## [1.10.1] - 2021-10-31
+
+### Fixed
+- Correct translation of number 18 for NL.mjs [#59](https://github.com/forzagreen/n2words/pull/59). Thanks to [@K4CZP3R](https://github.com/K4CZP3R) !
+- Update dev dependencies.
+
+
 ## [1.10.0] - 2021-08-22
 ### Added
 - New language: `id` Indonesian [#58](https://github.com/forzagreen/n2words/pull/58).

package/README.md

@@ -3,11 +3,20 @@
 [![Node CI](https://github.com/forzagreen/n2words/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/forzagreen/n2words/actions)
 [![Coverage Status](https://coveralls.io/repos/github/forzagreen/n2words/badge.svg?branch=master)](https://coveralls.io/github/forzagreen/n2words?branch=master)
 [![npm](https://img.shields.io/npm/v/n2words.svg)](https://npmjs.com/package/n2words)
-[![Gitter](https://img.shields.io/gitter/room/forzagreen/n2words)](https://gitter.im/forzagreen/n2words)
+[![npm](https://img.shields.io/npm/dw/n2words)](https://npmjs.com/package/n2words)
 
-n2words converts numbers to words. It supports multiple languages.
+n2words is a library that converts a numerical number into a written number. We have support for multiple languages (25 and growing) and our package is lightweight, modular and has no dependencies.
 
-n2words is a lightweight, easy to use package, with no dependencies. It works both in Node.js and in browsers.
+## How To
+
+```js
+n2words(123)   // 'one hundred and twenty-three'
+n2words(-1.5)  // 'minus one point five'
+
+n2words(123, {lang: 'fr'})  // 'cent vingt-trois'
+n2words(123, {lang: 'es'})  // 'ciento veintitrés'
+n2words(123, {lang: 'ar'})  // 'مائة و ثلاثة و عشرون'
+```
 
 ## Install
 
@@ -15,7 +24,7 @@ n2words is a lightweight, easy to use package, with no dependencies. It works bo
 npm install n2words
 ```
 
-n2words is available on [jsDelivr](https://jsdelivr.com/package/npm/n2words).
+n2words is also available on [jsDelivr](https://jsdelivr.com/package/npm/n2words).
 
 ## Usage
 
@@ -41,10 +50,10 @@ import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
 ```js
 import n2words from 'n2words'
 
-// ES6+
+// Source file
 import n2words from 'n2words/lib/n2words.mjs'
 
-// Individual languages
+// Individual languages (recommended)
 import n2wordsEN from 'n2words/lib/i18n/EN.mjs'
 ```
 
@@ -54,17 +63,6 @@ import n2wordsEN from 'n2words/lib/i18n/EN.mjs'
 <script src="n2words.js"></script>
 ```
 
-## Example
-
-```js
-n2words(123)   // 'one hundred and twenty-three'
-n2words(-1.5)  // 'minus one point five'
-
-n2words(123, {lang: 'en'})  // 'one hundred and twenty-three'
-n2words(123, {lang: 'fr'})  // 'cent vingt-trois'
-n2words(123, {lang: 'es'})  // 'ciento veintitrés'
-```
-
 ## Features
 
 - Cardinal numbers
@@ -82,6 +80,7 @@ n2words(123, {lang: 'es'})  // 'ciento veintitrés'
 - `fr` (French)
 - `fa` (Farsi)
 - `he` (Hebrew)
+- `hr` (Croatian)
 - `hu` (Hungarian)
 - `id` (Indonesian)
 - `it` (Italian)
@@ -98,12 +97,11 @@ n2words(123, {lang: 'es'})  // 'ciento veintitrés'
 - `uk` (Ukrainian)
 - `zh` (Chinese)
 
-
 ## Contributing
 
-You can help by adding a new language, or by imporving existing languages (report issues, verify the correctness of unit tests, add more test cases...).
+You can help by adding new languages or by improving existing ones. Also, reporting issues, verifying the correctness of unit tests or adding more test cases is extremely helpful.
 
-All help is welcome !
+All help is welcome!
 
 ## License