bmi-calc - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "bmi-calc",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "./index.js",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -6,17 +6,22 @@ bmi-calc
 
-# cli
+# example
 
-- Install [node](http://nodejs.org/download).
-- Run `npm install -g bmi-calc`
-- Run `bmi-calc --weight 170 --height 73`. (Except put in your weight and height.)
+```js
+var calcBmi = require('bmi-calc')
 
+// 154 lbs, 72 in, imperial
+console.log( calcBmi(154, 72, true) )
+// { value: 20.88, name: 'Normal' }
+
+// 69 kg, 1.62 m, metric
+console.log( calcBmi(69, 1.62, false) )
+// { value: 26.29, name: 'Overweight' }
+
+// 59 kg, 2 m, metric
+console.log( calcBmi(59, 2) )
+// { value: 14.75, name: 'Very Severely Underweight' }
 ```
-Usage: bmi-calc OPTIONS
+```
 
--h 64, --height=64    specify height in inches
--f 5, --feet=5        specify height in feet (can be used with -i)
--i 4, --inches=4      specify height in inches (can be used with -f)
--w 153, --weight=153  specify weight in pounds
--l 153, --lbs=153     specify weight in pounds
--p 153, --pounds=153  specify weight in pounds
+
 ```
@@ -46,4 +51,21 @@
 
+# cli
+
+- Install [node](http://nodejs.org/download).
+- Run `npm install -g bmi-calc`
+- Run `bmi-calc --weight 170 --height 73`. (Except put in your weight and height.)
+
+```
+Usage: bmi-calc OPTIONS
+
+-h 64, --height=64    specify height in inches
+-f 5, --feet=5        specify height in feet (can be used with -i)
+-i 4, --inches=4      specify height in inches (can be used with -f)
+-w 153, --weight=153  specify weight in pounds
+-l 153, --lbs=153     specify weight in pounds
+-p 153, --pounds=153  specify weight in pounds
+```
+
 # license
 
 MIT

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

5688

increased by7.67%

Number of lines in readme file

70

increased by45.83%

No dependency changes