currency-in-words - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "currency-in-words",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "convert currency or any numbers to corresponding words, eg: 1 -> \"one\", 10 -> \"ten\", 101 -> \"one hundred and one\" etc...",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -5,9 +5,24 @@ # currency-in-words
 ___
+> **Note**
+___
+> | 1. Current version supports only indian system. But, subsequent versions will support international version.|
+> | 2. Commas in the test cases are just for readability, but doesn't support in the input.                     |
+___
 
+### Installation:
+
 ```javascript
-import convert from 'currency-in-words'
+npm i currency-in-words
+```
 
+### Usage:
+
+```javascript
+import { convert } from 'currency-in-words'
+
 const result = convert('777')
 ```
 
+> Refer the images(test-cases) for more insight.
+
 Adding test-case results just to make your life easier..
@@ -18,1 +33,9 @@
 <img src="./public/test2.png">
+
+
+As we know it's hard to define the scope of a software. The scalability it offers is also a potential danger, as we might end up in a
+forever loop, adding feature after feature. Hence couple of limitations has been set going forth.
+
+1. Ignoring all decimals after two decimal places.
+2. Never going to address/handle commas in the input.
+3. Out put for decimals is in the format 'xxx yyy zzz.xx yy' without any spaces on either sides of the period, this is probably not gonna change for the sake of backward compatability. But you can always manipulate it with a little bit of your code.

No alert changes

Improved metrics

Total package byte prevSize

819538

increased by0.12%

Number of lines in readme file

40

increased by135.29%

No dependency changes