diff --git a/.github/media/icon-text-black.svg b/.github/media/icon-text-black.svg index 14f0fe0526..8a4bb4f679 100644 --- a/.github/media/icon-text-black.svg +++ b/.github/media/icon-text-black.svg @@ -1,9 +1,25 @@ - - - - - - - - + + + + + + + + + + + + + + + + + + + + Rivet Engine + + + + diff --git a/.github/media/icon-text-white.svg b/.github/media/icon-text-white.svg index 1807618212..8a10a54f28 100644 --- a/.github/media/icon-text-white.svg +++ b/.github/media/icon-text-white.svg @@ -1,9 +1,25 @@ - - - - - - - - + + + + + + + + + + + + + + + + + + + + Rivet Engine + + + + diff --git a/README.md b/README.md index 319543bc2b..3384dbc041 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ Generated from: site/scripts/generateReadme.mjs

-

The open-source alternative to Durable Objects

+

Scale and orchestrate RivetKit workloads

- 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.

Quickstart • @@ -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 @@ -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 @@ -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) diff --git a/README.rivet.tpl.md b/README.rivet.tpl.md index d7c0105a58..a53c422328 100644 --- a/README.rivet.tpl.md +++ b/README.rivet.tpl.md @@ -7,9 +7,9 @@

-

The open-source alternative to Durable Objects

+

Scale and orchestrate RivetKit workloads

- 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.

Quickstart • @@ -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 diff --git a/site/scripts/generateReadme.mjs b/site/scripts/generateReadme.mjs index d199430574..ed47233ff1 100755 --- a/site/scripts/generateReadme.mjs +++ b/site/scripts/generateReadme.mjs @@ -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. - **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