From 4dde7bf8770da24278c9b515cff051fe42c84cae Mon Sep 17 00:00:00 2001
From: Fredrik Strand Oseberg <fredrik.no@gmail.com>
Date: Tue, 14 Jan 2025 15:45:41 +0100
Subject: [PATCH] Docs/document events (#184)

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index bde1e50..ae41aa8 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,12 @@ yarn add @unleash/proxy-client-react unleash-proxy-client
 
 # How to use
 
+This library uses the core [unleash-proxy-client](https://github.com/Unleash/unleash-proxy-client-js) JS client as a base.
+
 ## Initialize the client
 
+*NOTE*: [unleash-proxy](https://github.com/Unleash/unleash-proxy) is in maintenance mode. It is recommend to use the [Frontend API](https://docs.getunleash.io/reference/front-end-api) or [unleash-edge](https://github.com/Unleash/unleash-edge) instead.
+
 Prepare [Unleash Proxy](https://docs.getunleash.io/reference/unleash-proxy) secret
 or [Frontend API Access](https://docs.getunleash.io/reference/front-end-api) token.
 
@@ -42,6 +46,8 @@ root.render(
 
 To connect this SDK to your Unleash instance's [front-end API](https://docs.getunleash.io/reference/front-end-api), use the URL to your Unleash instance's front-end API (`<unleash-url>/api/frontend`) as the `url` parameter. For the `clientKey` parameter, use a `FRONTEND` token generated from your Unleash instance. Refer to the [_how to create API tokens_](https://docs.getunleash.io/how-to/how-to-create-api-tokens) guide for the necessary steps.
 
+To connect this SDK to unleash-edge, follow the documentation provided in the [unleash-edge repository](https://github.com/unleash/unleash-edge).
+
 To connect this SDK to the [Unleash proxy](https://docs.getunleash.io/reference/unleash-proxy), use the proxy's URL and a [proxy client key](https://docs.getunleash.io/reference/api-tokens-and-client-keys#proxy-client-keys). The [_configuration_ section of the Unleash proxy docs](https://docs.getunleash.io/reference/unleash-proxy#configuration) contains more info on how to configure client keys for your proxy.
 
 ## Check feature toggle status
@@ -134,6 +140,36 @@ const MyComponent = ({ userId }) => {
 };
 ```
 
+## Listening to events
+
+The core JavaScript client emits various types of events depending on internal activities. You can listen to these events by using a hook to access the client and then directly attaching event listeners. Alternatively, if you're using the FlagProvider with a client, you can directly use this client to listen to the events. [See the full list of events here.](https://github.com/Unleash/unleash-proxy-client-js?tab=readme-ov-file#available-events)
+
+NOTE: `FlagProvider` uses these internal events to provide information through `useFlagsStatus`.
+
+```jsx
+import { useUnleashContext, useFlag } from '@unleash/proxy-client-react';
+
+const MyComponent = ({ userId }) => {
+  const client = useUnleashClient();
+
+  useEffect(() => {
+    if (client) {
+      const handleError = () => {
+        // Handle error
+      }
+
+      client.on('error', handleError)
+    }
+
+    return () => {
+      client.off('error', handleError)
+    }
+  }, [client])
+
+  // ...rest of component
+};
+```
+
 # Advanced use cases
 
 ## Deferring client start