From cc84241cea6f9c0e50778cd4024ea689d975ac2e Mon Sep 17 00:00:00 2001 From: Roland Kakonyi Date: Tue, 10 Oct 2023 11:45:40 +0200 Subject: [PATCH] feat(apidocs): add API reference link to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62de9eef..7596dc8a 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,10 @@ Please refer to the [Features](https://developer.bitmovin.com/playback/docs/reac ## Documentation +### API Reference + +Our API reference can be found [here](https://cdn.bitmovin.com/player/reactnative/0/docs/index.html). + ### Getting Started Guide Our [Getting Started Guide](https://developer.bitmovin.com/playback/docs/getting-started-react-native) walks you through setting up and configuring the Bitmovin Player in React Native projects. @@ -41,6 +45,7 @@ Check out our [React Native Guides](https://developer.bitmovin.com/playback/docs In the [/example/](https://github.com/bitmovin/bitmovin-player-react-native/tree/development/example) folder you can find a sample application showcasing many of the features of the Player React Native SDK. ## Maintenance and Updates + As an open source project, this library is not part of a regular maintenance or update schedule and is updated on an adhoc basis when contributions are made. ## Contributing to this project @@ -48,14 +53,17 @@ As an open source project, this library is not part of a regular maintenance or We are pleased to accept changes, updates and fixes from the community wishing to use and expand this project. Bitmovin will review any Pull Requests made. We do our best to provide timely feedback, but please note that no SLAs apply. New releases are tagged and published on our discretion. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to contribute. ## Raising a Feature Suggestion + If you see something missing that might be useful but are unable to contribute the feature yourself, please feel free to [submit a feature request](https://community.bitmovin.com/t/how-to-submit-a-feature-request-to-us/1463) through the Bitmovin Community. Feature suggestions will be considered by Bitmovin’s Product team for future roadmap plans. ## Reporting a bug + If you come across a bug related to the Player React Native SDK, please raise this through the support ticketing system accessible in your [Bitmovin Dashboard](https://dashboard.bitmovin.com/support/tickets). ## Support and SLA Disclaimer + As an open-source project and not a core product offering, any request, issue or query related to this project is excluded from any SLA and Support terms that a customer might have with either Bitmovin or another third-party service provider or Company contributing to this project. Any and all updates are purely at the contributor's discretion. ## Need more help? -Should you need further help, please raise your request to your Bitmovin account team. We can assist in a number of ways, from providing you professional services help to putting you in touch with preferred system integrators who can work with you to achieve your goals. +Should you need further help, please raise your request to your Bitmovin account team. We can assist in a number of ways, from providing you professional services help to putting you in touch with preferred system integrators who can work with you to achieve your goals.