Skip to content

Commit

Permalink
readme: add README information concerning react native
Browse files Browse the repository at this point in the history
  • Loading branch information
AndyTWF committed Sep 6, 2024
1 parent 7d42e72 commit 47adce8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ This SDK supports the following platforms:

**React**: The library ships with a number of providers and hooks for React, which provide a closer integration with that ecosystem. For more information on using Ably Chat in React, see the [React readme](./src/react/README.md).

**React Native** We aim to support all platforms supported by React Native. If you find any issues please raise an issue or contact us.

There is a known caveat in the current version of the library in environments where `structuredClone` is not defined. To address this, you can use a polyfill such as [@ungap/structured-clone](https://www.npmjs.com/package/@ungap/structured-clone).

## Supported chat features

This project is under development so we will be incrementally adding new features. At this stage, you'll find APIs for the following chat features:
Expand Down
7 changes: 3 additions & 4 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@
"Suspendable",
"Failable",
"livestreams",
"livestream"
"livestream",
"ungap"
],
"ignoreRegExpList": ["/.*@\\d{13}-/"],
"flagWords": [
"cancelled"
]
"flagWords": ["cancelled"]
}
10 changes: 7 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,21 @@
"main": "dist/chat/ably-chat.umd.cjs",
"browser": "dist/chat/ably-chat.js",
"types": "dist/chat/index.d.ts",
"react-native": "dist/react/ably-chat-react.umd.cjs",
"exports": {
".": {
"types": "./dist/chat/index.d.ts",
"import": "./dist/chat/ably-chat.js",
"require": "./dist/chat/ably-chat.umd.cjs"
"require": "./dist/chat/ably-chat.umd.cjs",
"react-native": "./dist/chat/ably-chat.umd.cjs"
},
"./react": {
"types": "./dist/react/index.d.ts",
"import": "./dist/react/ably-chat-react.js",
"require": "./dist/react/ably-chat-react.umd.cjs"
}
"require": "./dist/react/ably-chat-react.umd.cjs",
"react-native": "./dist/react/ably-chat-react.umd.cjs"
},
"./package.json": "./package.json"
},
"scripts": {
"lint": "eslint . && npm run cspell",
Expand Down

0 comments on commit 47adce8

Please sign in to comment.