docs: mark the react hooks as experimental

ably · Sep 4, 2023 · 49173e7 · 49173e7
1 parent 1b088b2
commit 49173e7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git 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
@@ -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: