Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 24 additions & 8 deletions .github/media/icon-text-black.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 24 additions & 8 deletions .github/media/icon-text-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Generated from: site/scripts/generateReadme.mjs
</a>
<br/>
<br/>
<p><b>The open-source alternative to Durable Objects</b></p>
<p><b>Scale and orchestrate RivetKit workloads</b></p>
<p>
Rivet Actors provide long-lived processes with durable state, realtime, and scalability.
Built to provide production grade scale and orchestration for the most intensive workloads.
</p>
<p>
<a href="https://rivet.gg/docs/actors/quickstart">Quickstart</a> •
Expand All @@ -38,16 +38,17 @@ Generated from: site/scripts/generateReadme.mjs

Public-facing projects:

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

Projects powering Rivet Engine:

- **[Pegboard](packages/services/pegboard/)**: Actor orchestrator
- **[Guard](packages/core/guard/)**: Proxy for routing traffic to Rivet Actors
- **[Gasoline](packages/common/gasoline/)**: Core durable execution engine that powers Rivet
- **[Chirp](packages/common/chirp-workflow/)**: Core workflow engine that powers Rivet

## Get Started

Expand All @@ -59,7 +60,7 @@ Get started with Rivet by following a quickstart guide:

## Features

Rivet Actors provide everything you need to build fast, scalable, and real-time applications without the complexity.
Rivet Actors, 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.

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

## BYO DB (Bring Your Own Database)
The Rivet Engine supports:

- **PostgreSQL**: For production deployments
- **FoundationDB**: For enterprise-scale distributed systems
- **Filesystem**: For single-node deployments

## Examples

- 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)
Expand Down
14 changes: 7 additions & 7 deletions README.rivet.tpl.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
</a>
<br/>
<br/>
<p><b>The open-source alternative to Durable Objects</b></p>
<p><b>Scale and orchestrate <a href="https://github.com/rivet-gg/rivetkit">RivetKit</a> workloads</b></p>
<p>
Rivet Actors provide long-lived processes with durable state, realtime, and scalability.
Built to provide production grade scale and orchestration for the most intensive workloads.
</p>
<p>
<a href="https://rivet.gg/docs/actors/quickstart">Quickstart</a> •
Expand All @@ -32,17 +32,17 @@

Public-facing projects:

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

Projects powering Rivet Engine:

- **[Pegboard](packages/edge/services/pegboard/)**: Actor orchestrator
- **[Guard](packages/edge/infra/guard/)**: Proxy for routing traffic to Rivet Actors
- **[Chirp](packages/common/chirp-workflow/)**: Core workflow engine that powers Rivet
- **[Pegboard](packages/services/pegboard/)**: Actor orchestrator
- **[Guard](packages/core/guard/)**: Proxy for routing traffic to Rivet Actors
- **[Gasoline](packages/common/gasoline/)**: Core durable execution engine that powers Rivet

## Get Started

Expand Down
11 changes: 9 additions & 2 deletions site/scripts/generateReadme.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,21 @@ const RIVET_QUICKSTART = `Get started with Rivet by following a quickstart guide
// Content chunks
const RIVET_FEATURES_CONTENT = `## Features

Rivet Actors provide everything you need to build fast, scalable, and real-time applications without the complexity.
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a grammatical issue in this sentence. It should be either "Rivet Actors, a primitive of RivetKit, provide everything..." or "Rivet Actors are a primitive of RivetKit and provide everything..." instead of the current construction which creates a run-on sentence.

Suggested change
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.
Rivet Actors, 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.

Spotted by Diamond

Fix in Graphite


Is this helpful? React 👍 or 👎 to let us know.


- **Long-Lived, Stateful Compute**: Like AWS Lambda but with memory and no timeouts
- **Blazing-Fast Reads & Writes**: State stored on same machine as compute
- **Realtime, Made Simple**: Built-in WebSockets and SSE support
- **Store Data Near Your Users**: Deploy to the edge for low-latency access
- **Infinitely Scalable**: Auto-scale from zero to millions without configuration
- **Fault Tolerant**: Automatic error handling and recovery built-in`;
- **Fault Tolerant**: Automatic error handling and recovery built-in

## BYO DB (Bring Your Own Database)
The Rivet Engine supports:

- **PostgreSQL**: For production deployments
- **FoundationDB**: For enterprise-scale distributed systems
- **Filesystem**: For single-node deployments`;

const RIVETKIT_FEATURES_CONTENT = `## Features

Expand Down
Loading