Skip to content

Commit

Permalink
fixup! Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
m-hulbert committed Jul 10, 2023
1 parent fe7505a commit 25b7614
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ Knowing where each user is within an application helps you understand their inte

**What is everyone doing in the application?**

All users should be working on the latest state of the application. If one user makes a change or an update, this change should be synced to a backend database and be immediately reflected in the UI for all users. For example, you can display a typing indicator when a colleague is editing a cell in a spreadsheet. As soon as they save their update, the new cell contents should be visible to all users.
Changes to the app state made by users not only need to be synced with your backend for validation and long term storage, but also be immediately reflected in the UI so that users are always viewing the latest information. For example, in a spreadsheet application, if one user has entered a value in a cell, all other users need to see that change instantly. Live updates help accomplish this in a collaborative space.

## Status

The Collaborative Spaces SDK is currently under development. If you are interested in being an early adopter and providing feedback then you can [sign up](https://go.ably.com/spaces-early-access) for early access and are welcome to [provide us with feedback](https://go.ably.com/spaces-feedback).

## Quickstart

Expand Down Expand Up @@ -65,7 +69,7 @@ To instantiate the Spaces SDK, create an [Ably client](https://ably.com/docs/get
import Spaces from '@ably-labs/spaces';
import { Realtime } from 'ably';

const client = new Realtime.Promise({key: "<API-key>", clientId: "<client-ID"});
const client = new Realtime.Promise({key: "<API-key>", clientId: "<client-ID>"});
const spaces = new Spaces(client);
```

Expand Down Expand Up @@ -221,7 +225,3 @@ The above listener will receive a `CursorUpdate` event:
"data": { "color": "red" }
}
```

## Status

The Collaborative Spaces SDK is currently under development. If you are interested in being an early adopter and providing feedback then you can [sign up](https://go.ably.com/spaces-early-access) for early access and are welcome to [provide us with feedback](https://go.ably.com/spaces-feedback).

0 comments on commit 25b7614

Please sign in to comment.