Merge pull request #82 from ably-labs/readme-ssr-note

docs: document requirement for client side rendering
ably-labs · Aug 30, 2023 · 15b59ff · 15b59ff
2 parents f507c3e + 8693955
commit 15b59ff
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -110,6 +110,8 @@ const { channel } = useChannel("your-channel-name", (message) => {
 
 Every time a message is sent to `your-channel-name` it'll be logged to the console. You can do whatever you need to with those messages.
 
+Our react hooks are designed to run on the client-side, so if you are using server-side rendering, make sure that your components which use Ably react hooks are only rendered on the client side.
+
 ---
 
 ### useChannel