From 49173e789ce51d54c180ea1395cdb252c661e94c Mon Sep 17 00:00:00 2001 From: Owen Pearson Date: Mon, 4 Sep 2023 14:17:26 +0100 Subject: [PATCH] docs: mark the react hooks as experimental --- README.md | 4 ++-- docs/react.md | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a1bb077680..f02ab6de2c 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ This SDK supports the following platforms: **TypeScript:** see [below](#typescript) -**React** We offer a set of react hooks which make it seamless to use ably-js in your react application. See the [react hooks documentation](./docs/react.md) for more details. - **WebWorkers**: We build a separate bundle which supports running in a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) context. You can import it like this: + +**React (experimental)** We offer a set of react hooks which make it seamless to use ably-js in your react application. See the [react hooks documentation](./docs/react.md) for more details. ```js import Ably from 'ably/build/ably-webworker.min'; ``` diff --git a/docs/react.md b/docs/react.md index c0c4347fe7..f98dd9912d 100644 --- a/docs/react.md +++ b/docs/react.md @@ -1,5 +1,8 @@ # ably-js React hooks +> [!IMPORTANT] +> The ably-js react hooks are currently in the release candidate phase, and there may be breaking changes in a future non-major release. + Use Ably in your React application using idiomatic, easy to use, React Hooks! Using this module you can: