Skip to content

docs: refresh README for public launch#25

Merged
affandar merged 1 commit into
mainfrom
docs/readme-refresh
Jun 2, 2026
Merged

docs: refresh README for public launch#25
affandar merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@affandar

@affandar affandar commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Refreshes the README ahead of the public launch.

What changed

  • Simpler start — leads with a plain-language intro on what durable execution buys you (30-day vs 30-ms waits, resume after crash).
  • Tighter bullets — split into What you get (4 bullets) and a one-line-per-capability What you can build.
  • Examples first — Hello world, plus a new Surviving crashes order-fulfillment example whose comments mark exactly where a crash recovers from. Fan-out, timers/events, and saga compensation follow.
  • How it works — concise turn-by-turn/replay explanation with determinism rules, linking to the canonical Durable Futures Internals doc.
  • Duroxide family — kept intact.
  • Consolidation — collapsed the verbose reference sections (Key types, Project layout, Status/control-plane, Instance management, Error classification, Stress testing, Runtime config, Observability, Notes) into a compact Learn more links list and a short Development block. Removed the stale per-release banner line.

No code changes.

- Lead with a plain-language intro on durable execution
- Tighten capability bullets into 'What you get' / 'What you can build'
- Reorder to examples-first; add a 'Surviving crashes' example showing crash-recovery points
- Add a concise 'How it works' section linking to durable-futures-internals
- Keep the Duroxide family; consolidate verbose reference sections into 'Learn more' + 'Development'
@affandar affandar merged commit fb5a625 into main Jun 2, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant