Skip to content

Commit f4fed1c

Browse files
committed
chore(docs): add Live Objects overview, installation, and examples to README
1 parent 8a347f5 commit f4fed1c

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,30 @@ realtimeClient.connection.on(ConnectionEvent.connected, connectionStateChange ->
103103
```
104104
---
105105

106+
## Live Objects
107+
108+
Ably Live Objects provide realtime, collaborative data structures that automatically synchronize state across all connected clients. Build interactive applications with shared data that updates instantly across devices.
109+
110+
### Installation
111+
112+
Add the following dependency to your `build.gradle` file:
113+
114+
```groovy
115+
dependencies {
116+
runtimeOnly("io.ably:live-objects:1.2.54")
117+
}
118+
```
119+
120+
### Documentation and Examples
121+
122+
- **[Live Objects Documentation](https://ably.com/docs/liveobjects)** - Complete guide to using Live Objects with code examples and API reference
123+
- **[Example App](./examples)** - Interactive demo showcasing Live Objects with realtime color voting and collaborative task management
124+
125+
The example app demonstrates:
126+
- **Color Voting**: Realtime voting system with live vote counts synchronized across all devices
127+
- **Task Management**: Collaborative task management where users can add, edit, and delete tasks that sync in realtime
128+
129+
To run the example app, follow the setup instructions in the [examples README](./examples/README.md).
106130

107131
## Proxy support
108132

0 commit comments

Comments
 (0)