From 2d0336c1279337c8bdf0173786de2d02eb38239b Mon Sep 17 00:00:00 2001 From: Lucy Keer Date: Wed, 4 Dec 2024 12:26:18 +0000 Subject: [PATCH] Add version info --- react-native/basic-example/README.md | 5 +++-- react/basic-example/README.md | 5 +++-- react/next.js/README.md | 5 +++-- react/remote-work-demo/README.md | 10 +++++----- react/team-chat-with-threads/README.md | 5 +++-- 5 files changed, 17 insertions(+), 13 deletions(-) diff --git a/react-native/basic-example/README.md b/react-native/basic-example/README.md index 461f9baf..c3aac007 100644 --- a/react-native/basic-example/README.md +++ b/react-native/basic-example/README.md @@ -5,5 +5,6 @@ The examples in this directory demonstrate how to use TalkJS with React Native t - [ReactNavigationExample](./ReactNavigationExample/) uses the [React Navigation](https://reactnavigation.org/docs/getting-started/) library to navigate between screens - [ReactNativeNavigationExample](./ReactNativeNavigationExample/) uses the [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) library -> [!TIP] -> [Download these example projects as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react-native.basic-example.zip) +The examples use React Native version 0.73. You can use the React Native SDK with versions 0.64 and up. + +> [!TIP] > [Download these example projects as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react-native.basic-example.zip) diff --git a/react/basic-example/README.md b/react/basic-example/README.md index f7bbd07e..f5ece4c2 100644 --- a/react/basic-example/README.md +++ b/react/basic-example/README.md @@ -2,8 +2,9 @@ This is a basic example that demonstrates how to integrate TalkJS into a React app with our [React SDK](https://talkjs.com/docs/Reference/React_SDK/Installation/), bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). -> [!TIP] -> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.basic-example.zip) +This example uses React version 18. You can use the React SDK with versions 17 and up. + +> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.basic-example.zip) ## Prerequisites diff --git a/react/next.js/README.md b/react/next.js/README.md index b2451ba7..6004ba85 100644 --- a/react/next.js/README.md +++ b/react/next.js/README.md @@ -4,8 +4,9 @@ This is a minimal example that demonstrates how to integrate TalkJS into a Next. The React SDK is not able to render components on the server, so we use Next.js's [Client Components](https://nextjs.org/docs/app/building-your-application/rendering/client-components) to render them on the client. -> [!TIP] -> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.next.js.zip) +This example uses React version 18. + +> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.next.js.zip) ## Prerequisites diff --git a/react/remote-work-demo/README.md b/react/remote-work-demo/README.md index d2d47791..ac8a4fa0 100644 --- a/react/remote-work-demo/README.md +++ b/react/remote-work-demo/README.md @@ -2,16 +2,16 @@ This example shows you how to use React and TalkJS to create a team chat with channels (like Slack or Teams). It's similar to the [remote work demo](https://talkjs.com/demo/team-chat/) that you can try on our website. See our [How to use TalkJS to create a team chat with channels](https://talkjs.com/resources/how-to-use-talkjs-to-create-a-team-chat-with-channels/) tutorial for more details. -> [!TIP] -> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.remote-work-demo.zip) +The example uses React version 18. You can use the React SDK with versions 17 and up. + +> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.remote-work-demo.zip) ## Instructions 1. Clone or [download this project](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.remote-work-demo.zip). 2. Install dependencies by either running `npm install` or `yarn`. 3. Create a [TalkJS account](https://talkjs.com/dashboard/signup/). -4. In `talkjsConfig.js`, replace `appId` with your own app ID. You can find your app ID on the **Settings** page of your [TalkJS dashboard](https://talkjs.com/dashboard/). +4. In `talkjsConfig.js`, replace `appId` with your own app ID. You can find your app ID on the **Settings** page of your [TalkJS dashboard](https://talkjs.com/dashboard/). 5. From this point on, you're ready to start up the app using using either `npm run` or `yarn start`. The app will be up and running at localhost:3000. -The app is prepopulated with a default user and a couple of hardcoded conversations, which easily can be replaced with your own users and conversations. You can find these conversations and the default `userId` in `src/talkJsConfig.js` as well. - +The app is prepopulated with a default user and a couple of hardcoded conversations, which easily can be replaced with your own users and conversations. You can find these conversations and the default `userId` in `src/talkJsConfig.js` as well. diff --git a/react/team-chat-with-threads/README.md b/react/team-chat-with-threads/README.md index 57dcbdbf..ab17e73e 100644 --- a/react/team-chat-with-threads/README.md +++ b/react/team-chat-with-threads/README.md @@ -4,8 +4,9 @@ This example extends our [team chat with channels example](https://github.com/ta See our [How to add reply threads to your TalkJS team chat](https://talkjs.com/resources/how-to-add-threads-to-your-team-chat-with-talkjs/) tutorial for more details. -> [!TIP] -> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.team-chat-with-threads.zip) +The example uses React version 18. You can use the React SDK with versions 17 and up. + +> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.team-chat-with-threads.zip) ## Prerequisites