Skip to content

Commit

Permalink
fix: note on metadata keys
Browse files Browse the repository at this point in the history
  • Loading branch information
robertherber committed Jan 1, 2021
1 parent 6520495 commit e9aa91e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ Since this package is using Swift you might also need to add a bridging header i
const lastWorkout = Healthkit.useMostRecentWorkout();
```

## A note on Apple Documentation

We're striving to do as straight a mapping as possible to the Native Libraries. This means that in most cases the Apple Documentation makes sense. However, when it comes to the Healthkit [Metadata Keys](https://developer.apple.com/documentation/healthkit/samples/metadata_keys) the documentation doesn't actually reflect the serialized values. For example HKMetadataKeyExternalUUID in the documentation serializes to HKExternalUUID - which is what we use.

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down
6 changes: 3 additions & 3 deletions example/ios/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ PODS:
- DoubleConversion
- glog
- glog (0.3.5)
- kingstinct-react-native-healthkit (1.0.1):
- kingstinct-react-native-healthkit (2.0.0):
- React
- OpenSSL-Universal (1.0.2.19):
- OpenSSL-Universal/Static (= 1.0.2.19)
Expand Down Expand Up @@ -424,7 +424,7 @@ SPEC CHECKSUMS:
FlipperKit: 6dc9b8f4ef60d9e5ded7f0264db299c91f18832e
Folly: 30e7936e1c45c08d884aa59369ed951a8e68cf51
glog: 1f3da668190260b06b429bb211bfbee5cd790c28
kingstinct-react-native-healthkit: cf8b8900e76c9c06cb3bf9ede715a1b4bf3cd8f4
kingstinct-react-native-healthkit: 7392fd7ce438c52d8d4ea730c7a436ef233274a9
OpenSSL-Universal: 8b48cc0d10c1b2923617dfe5c178aa9ed2689355
RCTRequired: cec6a34b3ac8a9915c37e7e4ad3aa74726ce4035
RCTTypeSafety: 93006131180074cffa227a1075802c89a49dd4ce
Expand All @@ -451,4 +451,4 @@ SPEC CHECKSUMS:

PODFILE CHECKSUM: 7732754628d3c1216cf740618346e7de35cae9f3

COCOAPODS: 1.8.4
COCOAPODS: 1.10.0

0 comments on commit e9aa91e

Please sign in to comment.