Skip to content

Commit b3abfaf

Browse files
tjgreen42Copilot
andcommitted
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>
1 parent 140b2b4 commit b3abfaf

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,31 @@ Python-only changes (`python/duroxide/`, `tests/`) take effect immediately.
290290

291291
See [CHANGELOG.md](https://github.com/microsoft/duroxide-python/blob/main/CHANGELOG.md) for release notes.
292292

293+
## The Duroxide family
294+
295+
Several related projects share Duroxide's durable-execution model. Pick the
296+
one that fits how you want to author and host your workflows:
297+
298+
- **[pg_durable](https://github.com/microsoft/pg_durable)** — PostgreSQL
299+
extension. Use this when you want durable pipelines and functions
300+
**directly in PostgreSQL**, with no other moving parts.
301+
- **[duroxide](https://github.com/microsoft/duroxide)** — Rust
302+
durable-execution runtime. Use this when you want to author workflows in
303+
**Rust** and embed the runtime in your service. Multiple storage
304+
providers are available (SQLite built-in, PostgreSQL via
305+
[duroxide-pg](https://github.com/microsoft/duroxide-pg), or bring your
306+
own).
307+
- **[duroxide-python](https://github.com/microsoft/duroxide-python)**
308+
_(this repo)_ — Python SDK over the duroxide runtime. Use this when you
309+
want to author workflows in **Python**.
310+
- **[duroxide-node](https://github.com/microsoft/duroxide-node)**
311+
Node.js / TypeScript SDK over the duroxide runtime. Use this when you
312+
want to author workflows in **JavaScript / TypeScript**.
313+
- **[duroxide-pg](https://github.com/microsoft/duroxide-pg)** — PostgreSQL
314+
provider for the duroxide runtime. Plug this into duroxide /
315+
duroxide-python / duroxide-node when you want **PostgreSQL** as the
316+
durable store.
317+
293318
## Documentation
294319

295320
- [User Guide](https://github.com/microsoft/duroxide-python/blob/main/docs/user-guide.md) — orchestration patterns, activities, providers, tracing, determinism rules

0 commit comments

Comments
 (0)