Update README.md

added permissions section to readme

Update README.md
added permissions section to readme
21e0d73d · Greg Wilson · GitHub · 13eef439 · 21e0d73d
Commit 21e0d73d authored Jun 27, 2016 by Greg Wilson Committed by GitHub Jun 27, 2016
Hide whitespace changes
Inline Side-by-side

Showing with 28 additions and 0 deletions

README.md README.md +28 -0

No files found.
--- a/README.md
+++ b/README.md
@@ -75,6 +75,34 @@ AppleHealthKit.saveWeight({weight:myWeight}, (err, res) => {

 ## Documentation

+### Permissions
+
+The available HealthKit permissions to use with `initHealthKit` 
+
+Read Permissions:
+
+    Height               HKQuantityTypeIdentifierHeight
+    Weight               HKQuantityTypeIdentifierBodyMass
+    BodyFatPercentage    HKQuantityTypeIdentifierBodyFatPercentage
+    BodyMassIndex        HKQuantityTypeIdentifierBodyMassIndex
+    LeanBodyMass         HKQuantityTypeIdentifierLeanBodyMass
+    Steps                HKQuantityTypeIdentifierStepCount
+    Sex                  HKCharacteristicTypeIdentifierBiologicalSex
+    DateOfBirth          HKCharacteristicTypeIdentifierDateOfBirth
+    DietaryEnergy        HKQuantityTypeIdentifierDietaryEnergyConsumed
+    ActiveEnergy         HKQuantityTypeIdentifierActiveEnergyBurned
+    
+Write Permissions:
+
+    Height               HKQuantityTypeIdentifierHeight
+    Weight               HKQuantityTypeIdentifierBodyMass
+    BodyFatPercentage    HKQuantityTypeIdentifierBodyFatPercentage
+    BodyMassIndex        HKQuantityTypeIdentifierBodyMassIndex
+    LeanBodyMass         HKQuantityTypeIdentifierLeanBodyMass
+    Steps                HKQuantityTypeIdentifierStepCount
+    DietaryEnergy        HKQuantityTypeIdentifierDietaryEnergyConsumed
+    ActiveEnergy         HKQuantityTypeIdentifierActiveEnergyBurned
+        
 ### Methods

 **`isAvailable`** : check if HealthKit is available on the device