healthstats - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "healthstats",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Calculate BMI, BMR, and IBW.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -0,6 +1,17 @@
+#Health Stats
+
+### Node module for calculating BMI, BMR and IBW:
+
+#####How to:
+1. npm install healthstats
+2. include healthstats in your .js file
+ 
+```javascript
+var health = require('healthstats');
+```
 ##Public Methods:
 #####Body Masss Index - BMI
 ```javascript
-female.BMI(weight, height);
-male.BMI(weight, height);
+health.female.BMI(weight, height);
+health.male.BMI(weight, height);
 ```
@@ -11,4 +22,4 @@ #####Basal Metabolic Rate - BMR
 ```javascript
-female.BMR(weight, height, age);
-male.BMR(weight, height, age);
+health.female.BMR(weight, height, age);
+health.male.BMR(weight, height, age);
 ```
@@ -21,16 +32,16 @@
 //Sedentary 
-female.noActivity(female.BMR);
-male.noActivity(male.BMR);
+health.female.noActivity(female.BMR);
+health.male.noActivity(male.BMR);
 //Light Activity 
-female.lightActivity(female.BMR);
-male.lightActivity(male.BMR);
+health.female.lightActivity(female.BMR);
+health.male.lightActivity(male.BMR);
 //Moderate Activity 
-female.moderateActivity(female.BMR);
-male.moderateActivity(male.BMR);
+health.female.moderateActivity(female.BMR);
+health.male.moderateActivity(male.BMR);
 //Very Active
-female.veryActive(female.BMR);
-male.verActive(male.BMR)
+health.female.veryActive(female.BMR);
+health.male.verActive(male.BMR)
 //Extremely Active
-female.extremelyActive(female.BMR);
-male.extremelyActive(male.BMR);
+health.female.extremelyActive(female.BMR);
+health.male.extremelyActive(male.BMR);
 ```
@@ -40,4 +51,4 @@
 ```javascript
-female.IBW(height);
-male.IBW(height);
+health.female.IBW(height);
+health.male.IBW(height);
 ```
@@ -44,0 +55,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

3899

increased by8.79%

Number of lines in readme file

57

increased by23.91%

No dependency changes