Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

demo-app: Update the readme to include Chat React hooks usage. #355

Merged
merged 1 commit into from
Oct 14, 2024
Merged

demo-app: Update the readme to include Chat React hooks usage. #355

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Chat SDK Demo

An app showcasing the usage of Chat SDK to build chat.
An app showcasing the usage of Chat SDK with Chat React hooks to build chat.

Quickstart install-to-browser, from this folder run:

Expand All @@ -10,9 +10,12 @@ npm install
npm run start
```

## Installation
##   Installation

1. First of all, you need to build the main Chat SDK from the root directory (`(cd .. && npm run build)`).
> [!NOTE] This demo app uses both the `ably-chat-js` core SDK and associated React hooks.
> The latter is accessible via `@ably/chat/react` once the `@ably/chat` package has been installed.

1. First of all, you need to build the main Chat SDK and associated React hooks from the root directory (`(cd .. && npm run build)`).
2. Run `npm install` here.

## Credential Setup
Expand Down
Loading