Skip to content

Commit

Permalink
Merge pull request #272 from agencyenterprise/readme-updates
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
RuanAzevedo committed Jan 7, 2023
2 parents fb4cf7e + 104a8d7 commit a784f8c
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

# React Native Health

A React Native package to interact with Apple HealthKit for iOS.
A React Native package to interact with Apple HealthKit for iOS. Maintained with ❤️ by [AE Studio](https://ae.studio).

This package allows access to health & fitness data exposed by Apple Healthkit. You can see the methods available [here](https://github.com/agencyenterprise/react-native-health#documentation).

If you are looking for a more robust solution providing normalized data, insights and recommendations based on user's biometric data, data from multiple sources (Fitbit, Oura), or a hosted solution, please check out the [Point SDK](https://www.areyouonpoint.co/) developed by our frens.


# Discord
<a href="https://discord.gg/d24g5XDePr"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="React Native Health official Discord"></a>
Expand Down Expand Up @@ -99,7 +104,7 @@ AppleHealthKit.initHealthKit(permissions, (error: string) => {
For background capabilities, Apple allows developers to setup long running observer
queries for the health types needed.

To setup that in your app, in XCode open your `ios/AppDelegate.m` file and add the
To set that up in your app, in XCode open your `ios/AppDelegate.m` file and add the
following statements:

```objective-c
Expand Down Expand Up @@ -136,10 +141,9 @@ client. For more information, see [background observers](/docs/background.md).
## Documentation
There is a gitbook version for the documentation on this [link](https://docs.react-native-health.com/).
There is a gitbook version for the documentation [here](https://docs.react-native-health.com/).
All the documentation is under the [docs](/docs) folder. Additionally,
they are splitted in the following categories
All the documentation is under the [docs](/docs) folder. They are split into the following categories:
### Constants
Expand Down Expand Up @@ -285,7 +289,7 @@ specific permission or add the permission to the options object when
initializing the library.
If extra read or write permissions are added to the options object, the
app will request for user's permission to them when the library is
app will request the user's permission when the library is
initialized again.
### Manual Installation
Expand All @@ -306,7 +310,7 @@ initialized again.
## Contributing
We appreciate any additional request and/or contribution to `react-native-health`.
We appreciate any requests and contributions to `react-native-health`.
The [issues](https://github.com/agencyenterprise/react-native-health/issues) tracker
is used to keep a list of features and bugs to be worked on. Please see our
[contributing documentation](https://github.com/agencyenterprise/react-native-health/blob/master/CONTRIBUTING.md)
Expand All @@ -321,3 +325,7 @@ for some tips on getting started.
> _This package is a fork of [rn-apple-healthkit](https://github.com/terrillo/rn-apple-healthkit)_
> _This package also inherits additional features from [Nutrisense](https://www.nutrisense.io/) fork_
## Plz I Still Need Halp
This package is maintained with ❤️ by [AE Studio](https://ae.studio). We will do our best to respond to requests and support for this package so please get in touch! If you require more extensive help or have other design, data science or development needs - we are a full service product development agency and can build pretty much anything so hit us up!

0 comments on commit a784f8c

Please sign in to comment.