diff --git a/README.md b/README.md index ac1e424b79c6d408e95cb405c4634dfdfe59aa44..b0335552ece933ec7d0bfa83e79e8db665972158 100644 --- 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