From 2bf77c01977db55d228859d9e2729e72cfc8e4c7 Mon Sep 17 00:00:00 2001 From: Todd Green Date: Thu, 28 May 2026 19:45:32 +0000 Subject: [PATCH] docs: add "The Duroxide family" cross-link section to README Adds a short section near the top of the README that names the related projects (pg_durable, duroxide, duroxide-pg, duroxide-python, duroxide-node) and explains which to pick. The same block is being added to the other repos so cross-links resolve from any entry point. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 9bf7a28..67cbff5 100644 --- a/README.md +++ b/README.md @@ -209,6 +209,31 @@ async fn comp_sample(ctx: OrchestrationContext) -> String { - Run `cargo run --example metrics_cli` to see observability dashboard - See `docs/observability-guide.md` for complete guide +### The Duroxide family + +Several related projects share Duroxide's durable-execution model. Pick the +one that fits how you want to author and host your workflows: + +- **[pg_durable](https://github.com/microsoft/pg_durable)** — PostgreSQL + extension. Use this when you want durable pipelines and functions + **directly in PostgreSQL**, with no other moving parts. +- **[duroxide](https://github.com/microsoft/duroxide)** _(this repo)_ — + Rust durable-execution runtime. Use this when you want to author + workflows in **Rust** and embed the runtime in your service. Multiple + storage providers are available (SQLite built-in, PostgreSQL via + [duroxide-pg](https://github.com/microsoft/duroxide-pg), or bring your + own). +- **[duroxide-python](https://github.com/microsoft/duroxide-python)** — + Python SDK over the duroxide runtime. Use this when you want to author + workflows in **Python**. +- **[duroxide-node](https://github.com/microsoft/duroxide-node)** — + Node.js / TypeScript SDK over the duroxide runtime. Use this when you + want to author workflows in **JavaScript / TypeScript**. +- **[duroxide-pg](https://github.com/microsoft/duroxide-pg)** — PostgreSQL + provider for the duroxide runtime. Plug this into duroxide / + duroxide-python / duroxide-node when you want **PostgreSQL** as the + durable store. + ### Notes - Import as `duroxide` in Rust source. - Timers are real time (Tokio sleep). External events are via `Runtime::raise_event`.