financial - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

@@ -5,3 +5,3 @@ {
   "author": "Luciano Mammino <[e-mail]> (https://loige.co)",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "repository": {
@@ -8,0 +8,0 @@ "type": "git",

README.md

@@ -10,3 +10,3 @@ # Financial
 
-It does support the same functionality offered by `numpy-financial` but it only support scalar values (no numpy-like array values) and it does not support decimal values.
+It does support the same functionality offered by `numpy-financial` but it only support scalar JavaScript `number` values (NO numpy-like array values) and it does NOT support arbitrary-precision signed decimal numbers (such as decimal.js, big.js or bignumber.js).
 
@@ -17,2 +17,5 @@
 
+[![Example usage in a picture](https://repository-images.githubusercontent.com/275629272/b295b880-bd3e-11ea-8860-705f2f6427ec)](https://repository-images.githubusercontent.com/275629272/b295b880-bd3e-11ea-8860-705f2f6427ec)
+
+
 ## Install
@@ -96,16 +99,18 @@
 
-## Implemented functions
+## Implemented functions and Documentation
 
- - [X] `fv` (since v0.0.12)
- - [X] `pmt` (since v0.0.12)
- - [X] `nper` (since v0.0.12)
- - [X] `ipmt` (since v0.0.12)
- - [X] `ppmt` (since v0.0.14)
- - [X] `pv` (since v0.0.15)
- - [X] `rate` (since v0.0.16)
- - [X] `irr` (since v0.0.17)
- - [X] `npv` (since v0.0.18)
- - [X] `mirr` (since 0.1.0)
+Click on the function name to get the full documentation for every function, or check out the full programmatic documentation at [financialjs.netlify.app](https://financialjs.netlify.app).
 
+ - [X] [`fv()`: Future Value](https://financialjs.netlify.app/modules/_financial_.html#fv) (since v0.0.12)
+ - [X] [`pmt()`: Total payment](https://financialjs.netlify.app/modules/_financial_.html#pmt) (since v0.0.12)
+ - [X] [`nper()`: Number of period payments](https://financialjs.netlify.app/modules/_financial_.html#nper) (since v0.0.12)
+ - [X] [`ipmt()`: Interest portion of a payment](https://financialjs.netlify.app/modules/_financial_.html#ipmt) (since v0.0.12)
+ - [X] [`ppmt()`: Payment against loan principal](https://financialjs.netlify.app/modules/_financial_.html#ppmt) (since v0.0.14)
+ - [X] [`pv()`: Present Value](https://financialjs.netlify.app/modules/_financial_.html#pv) (since v0.0.15)
+ - [X] [`rate()`: Rate of interest per period](https://financialjs.netlify.app/modules/_financial_.html#rate) (since v0.0.16)
+ - [X] [`irr()`: Internal Rate of Return](https://financialjs.netlify.app/modules/_financial_.html#irr) (since v0.0.17)
+ - [X] [`npv()`: Net Present Value](https://financialjs.netlify.app/modules/_financial_.html#npv) (since v0.0.18)
+ - [X] [`mirr()`: Modified Internal Rate of Return](https://financialjs.netlify.app/modules/_financial_.html#mirr) (since 0.1.0)
 
+
 ## Local Development
@@ -112,0 +117,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

177548

increased by0.81%

Number of lines in readme file

142

increased by3.65%

No dependency changes