n2words 1.15.0 → 1.16.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Wael TELLAT
+Copyright (c) 2018-2023 Wael TELLAT
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,12 +4,11 @@
 [![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)
 [![npm](https://img.shields.io/npm/dw/n2words)](https://npmjs.com/package/n2words)
+[![](https://data.jsdelivr.com/v1/package/npm/n2words/badge)](https://www.jsdelivr.com/package/npm/n2words)
 
-n2words is a library that converts a numerical number into a written number.
+__n2words__ converts a numerical number into a written one, supports [27 languages](https://github.com/forzagreen/n2words#supported-languages), and has zero dependencies.
 
-We have support for multiple languages (27 and growing) and our package is lightweight, modular and has no dependencies.
-
-## How To
+## Example
 
 ```js
 n2words(123)   // 'one hundred and twenty-three'
@@ -20,6 +19,8 @@ n2words(123, {lang: 'es'})  // 'ciento veintitrés'
 n2words(123, {lang: 'ar'})  // 'مائة و ثلاثة و عشرون'
 ```
 
+See the [Wiki](https://github.com/forzagreen/n2words/wiki) for examples and advanced usage.
+
 ## Install
 
 ```sh
@@ -34,42 +35,28 @@ n2words is also available on [jsDelivr](https://jsdelivr.com/package/npm/n2words
 
 ```js
 import n2words from 'n2words'
-
-// Source file
-import n2words from 'n2words/lib/n2words.mjs'
-
-// Individual languages (recommended)
-import n2wordsEN from 'n2words/lib/i18n/EN.mjs'
 ```
 
 ### CommonJS
 
 ```js
-var n2words = require('n2words')
-
-// Dynamic Import (source files)
-import('n2words/lib/n2words.mjs').then(n2words => {
+// Dynamic Import
+import('n2words').then(n2words => {
     // Available via "default" method
     n2words.default(100)
 })
-
-// Individual languages
-import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
-    n2wordsEN.default(100)
-})
 ```
 
 ### Browser
 
 ```html
 <script src="n2words.js"></script>
+<script>
+    n2words(100)
+</script>
 ```
 
-## Features
-
-- Cardinal numbers
-- Decimal numbers
-- Negative numbers
+You can also [import only specific languages](https://github.com/forzagreen/n2words/wiki/Importing-only-specific-languages) if you don't need all of them.
 
 ## Supported Languages
 
@@ -103,10 +90,7 @@ import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
 
 ## Contributing
 
-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!
-
+__This library is in active development.__ We are looking to improve the design and process for language contributors as well as add more languages.
 ## License
 
-MIT
+[MIT](https://github.com/forzagreen/n2words/blob/master/LICENSE)