Skip to content

Commit d8ed99f

Browse files
NicholasKisselNicholasKissel
committed
chore: update readme and logo
1 parent b9309a2 commit d8ed99f

File tree

5 files changed

+77
-31
lines changed

5 files changed

+77
-31
lines changed

‎.github/media/icon-text-black.svg‎

Lines changed: 24 additions & 8 deletions
Loading

‎.github/media/icon-text-white.svg‎

Lines changed: 24 additions & 8 deletions
Loading

‎README.md‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Generated from: site/scripts/generateReadme.mjs
1313
</a>
1414
<br/>
1515
<br/>
16-
<p><b>The open-source alternative to Durable Objects</b></p>
16+
<p><b>Scale and orchestrate RivetKit workloads</b></p>
1717
<p>
18-
Rivet Actors provide long-lived processes with durable state, realtime, and scalability.
18+
Built to provide production grade scale and orchestration for the most intensive workloads.
1919
</p>
2020
<p>
2121
<a href="https://rivet.gg/docs/actors/quickstart">Quickstart</a> •
@@ -38,16 +38,16 @@ Generated from: site/scripts/generateReadme.mjs
3838

3939
Public-facing projects:
4040

41-
- **Rivet Engine** (you are here): Engine that powers Rivet Actors at scale
41+
- **Rivet Engine** (you are here): Engine that powers RivetKit at scale
4242
- **[RivetKit](https://github.com/rivet-gg/rivetkit)**: Lightweight TypeScript library for building Rivet Actors — works with Redis or Rivet Engine
43-
- **[Rivet Studio](/frontend/apps/studio)**: Like Postman, but for Rivet Actors
43+
- **[Rivet Inspector](/frontend/apps/studio)**: Like Postman, but for Rivet Actors
4444
- **[Rivet Hub](/frontend/apps/hub)**: UI for Rivet Engine
4545
- **[Rivet Documentation](/site/src/content/docs)**
4646

4747
Projects powering Rivet Engine:
4848

49-
- **[Pegboard](packages/edge/services/pegboard/)**: Actor orchestrator
50-
- **[Guard](packages/edge/infra/guard/)**: Proxy for routing traffic to Rivet Actors
49+
- **[Pegboard](packages/services/pegboard/)**: Actor orchestrator
50+
- **[Guard](packages/core/guard/)**: Proxy for routing traffic to Rivet Actors
5151
- **[Chirp](packages/common/chirp-workflow/)**: Core workflow engine that powers Rivet
5252

5353
## Get Started
@@ -60,7 +60,7 @@ Get started with Rivet by following a quickstart guide:
6060

6161
## Features
6262

63-
Rivet Actors provide everything you need to build fast, scalable, and real-time applications without the complexity.
63+
Rivet Actors are a primitive of RivetKit provide everything you need to build fast, scalable, and real-time applications without the complexity. Rivet Engine is the core of self-hosting and is used for orchestrating actors at scale.
6464

6565
- **Long-Lived, Stateful Compute**: Like AWS Lambda but with memory and no timeouts
6666
- **Blazing-Fast Reads & Writes**: State stored on same machine as compute
@@ -69,6 +69,13 @@ Rivet Actors provide everything you need to build fast, scalable, and real-time
6969
- **Infinitely Scalable**: Auto-scale from zero to millions without configuration
7070
- **Fault Tolerant**: Automatic error handling and recovery built-in
7171

72+
## BYO DB (Bring Your Own Database)
73+
The Rivet Engine supports:
74+
75+
- **PostgreSQL**: For production deployments
76+
- **FoundationDB**: For enterprise-scale distributed systems
77+
- **Filesystem**: For single-node deployments
78+
7279
## Examples
7380

7481
- AI Agent — [GitHub](https://github.com/rivet-gg/rivetkit/tree/main/examples/ai-agent) · [StackBlitz](https://stackblitz.com/github/rivet-gg/rivetkit/tree/main/examples/ai-agent)

‎README.rivet.tpl.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
</a>
88
<br/>
99
<br/>
10-
<p><b>The open-source alternative to Durable Objects</b></p>
10+
<p><b>Scale and orchestrate RivetKit workloads</b></p>
1111
<p>
12-
Rivet Actors provide long-lived processes with durable state, realtime, and scalability.
12+
Built to provide production grade scale and orchestration for the most intensive workloads.
1313
</p>
1414
<p>
1515
<a href="https://rivet.gg/docs/actors/quickstart">Quickstart</a> •
@@ -32,16 +32,16 @@
3232

3333
Public-facing projects:
3434

35-
- **Rivet Engine** (you are here): Engine that powers Rivet Actors at scale
35+
- **Rivet Engine** (you are here): Engine that powers RivetKit at scale
3636
- **[RivetKit](https://github.com/rivet-gg/rivetkit)**: Lightweight TypeScript library for building Rivet Actors — works with Redis or Rivet Engine
37-
- **[Rivet Studio](/frontend/apps/studio)**: Like Postman, but for Rivet Actors
37+
- **[Rivet Inspector](/frontend/apps/studio)**: Like Postman, but for Rivet Actors
3838
- **[Rivet Hub](/frontend/apps/hub)**: UI for Rivet Engine
3939
- **[Rivet Documentation](/site/src/content/docs)**
4040

4141
Projects powering Rivet Engine:
4242

43-
- **[Pegboard](packages/edge/services/pegboard/)**: Actor orchestrator
44-
- **[Guard](packages/edge/infra/guard/)**: Proxy for routing traffic to Rivet Actors
43+
- **[Pegboard](packages/services/pegboard/)**: Actor orchestrator
44+
- **[Guard](packages/core/guard/)**: Proxy for routing traffic to Rivet Actors
4545
- **[Chirp](packages/common/chirp-workflow/)**: Core workflow engine that powers Rivet
4646

4747
## Get Started

‎site/scripts/generateReadme.mjs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,21 @@ const RIVET_QUICKSTART = `Get started with Rivet by following a quickstart guide
1818
// Content chunks
1919
const RIVET_FEATURES_CONTENT = `## Features
2020
21-
Rivet Actors provide everything you need to build fast, scalable, and real-time applications without the complexity.
21+
Rivet Actors are a primitive of RivetKit provide everything you need to build fast, scalable, and real-time applications without the complexity. Rivet Engine is the core of self-hosting and is used for orchestrating actors at scale.
2222
2323
- **Long-Lived, Stateful Compute**: Like AWS Lambda but with memory and no timeouts
2424
- **Blazing-Fast Reads & Writes**: State stored on same machine as compute
2525
- **Realtime, Made Simple**: Built-in WebSockets and SSE support
2626
- **Store Data Near Your Users**: Deploy to the edge for low-latency access
2727
- **Infinitely Scalable**: Auto-scale from zero to millions without configuration
28-
- **Fault Tolerant**: Automatic error handling and recovery built-in`;
28+
- **Fault Tolerant**: Automatic error handling and recovery built-in
29+
30+
## BYO DB (Bring Your Own Database)
31+
The Rivet Engine supports:
32+
33+
- **PostgreSQL**: For production deployments
34+
- **FoundationDB**: For enterprise-scale distributed systems
35+
- **Filesystem**: For single-node deployments`;
2936

3037
const RIVETKIT_FEATURES_CONTENT = `## Features
3138

0 commit comments

Comments
 (0)