Skip to content

Commit 572a6ef

Browse files
committed
chore: update readme for new quickstart (#663)
1 parent 09626c0 commit 572a6ef

File tree

1 file changed

+14
-24
lines changed

1 file changed

+14
-24
lines changed

README.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
The modern way to build multiplayer, realtime, or AI agent backends.
2525

26-
Supports [Rivet](https://rivet.gg/docs/setup), [Cloudflare Workers](https://actorcore.org/platforms/cloudflare-workers), [Bun](https://actorcore.org/platforms/bun), and [Node.js](https://actorcore.org/platforms/nodejs).
26+
Runs on [Rivet](https://rivet.gg/docs/setup), [Cloudflare Workers](https://actorcore.org/platforms/cloudflare-workers), [Bun](https://actorcore.org/platforms/bun), and [Node.js](https://actorcore.org/platforms/nodejs). Integrates with [Hono](https://actorcore.org/integrations/hono) and [Redis](https://actorcore.org/drivers/redis).
2727

2828
### Architecture
2929

@@ -59,25 +59,24 @@ _\- = requires significant boilerplate code or external service_
5959

6060
_† = on supported platforms_
6161

62-
## Getting Started
62+
## Quickstart
6363

64-
### Step 1: Installation
64+
Run this command:
6565

66-
```bash npm
67-
# npm
68-
npm add actor-core
66+
```
67+
npx create-actor@latest
68+
```
6969

70-
# pnpm
71-
pnpm add actor-core
70+
## Supported Platforms
7271

73-
# Yarn
74-
yarn add actor-core
72+
- [**Rivet**](https://actorcore.org/platforms/rivet)
73+
- [**Cloudflare Workers**](https://actorcore.org/platforms/cloudflare-workers)
74+
- [**Bun**](https://actorcore.org/platforms/bun)
75+
- [**Node.js**](https://actorcore.org/platforms/nodejs)
7576

76-
# Bun
77-
bun add actor-core
78-
```
77+
## Overview
7978

80-
### Step 2: Create an Actor
79+
**Create Actor**
8180

8281
```typescript
8382
import { Actor, type Rpc } from "actor-core";
@@ -103,7 +102,7 @@ export default class ChatRoom extends Actor<State> {
103102
}
104103
```
105104

106-
### Step 3: Connect to Actor
105+
**Connect to Actor**
107106

108107
```typescript
109108
import { Client } from "actor-core/client";
@@ -123,15 +122,6 @@ chatRoom.on("newMessage", (username: string, message: string) =>
123122
await chatRoom.sendMessage("william", "All the world's a stage.");
124123
```
125124

126-
### Step 4: Deploy
127-
128-
Deploy to your platform of choice:
129-
130-
- [**Rivet**](https://rivet.gg/docs/setup)
131-
- [**Cloudflare Workers**](https://actorcore.org/platforms/cloudflare-workers)
132-
- [**Bun**](https://actorcore.org/platforms/bun)
133-
- [**Node.js**](https://actorcore.org/platforms/nodejs)
134-
135125
## Community & Support
136126

137127
- Join our [**Discord**](https://rivet.gg/discord)

0 commit comments

Comments
 (0)