Skip to content

Commit b7ee0c9

Browse files
committed
docs: trim README for readability
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
1 parent e77d8de commit b7ee0c9

1 file changed

Lines changed: 7 additions & 31 deletions

File tree

README.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,15 @@ source also ships composable reliability middleware as its own opt-in modules
7070
(`source/retry`, `source/dlq`, `source/idempotency`, `source/schema`) and an
7171
in-memory `source/memsource` test source, each experimental.
7272

73-
The engine emits effects as pure data; the IO modules are the thin seams that
74-
carry those effects to real transports and sinks. Each is
75-
"bring your own adapter," none forced on the consumer.
76-
7773
## Status
7874

79-
Early and evolving. The `state` module is now a complete, embeddable statechart
80-
engine, covering hierarchical, parallel, and final states; history; guard combinators;
81-
delayed transitions; invoked services; an actor model with message passing;
82-
snapshots; inspection; and JSON (de)serialization. It is backed by its `analysis`,
83-
`evolution`, and `conformance` companion packages. Treat its API as experimental
84-
until it reaches v1. The `telemetry` interface and its `slog`, `otel`, and
85-
`datadog` adapters are released. The `sink` egress seam and its destination
86-
adapters, and the `source` ingress seam with its Kafka, JetStream, and Redis
87-
Streams adapters, CloudEvents and CDC codecs, reliability middleware, and
88-
state-machine bridge, are now available and documented; the `broker` module is
89-
planned.
75+
Early and evolving. `state` is a complete, embeddable statechart engine, covering
76+
hierarchical, parallel, and final states, history, guard combinators, delayed
77+
transitions, invoked services, an actor model, snapshots, and JSON
78+
(de)serialization, backed by its `analysis`, `evolution`, and `conformance`
79+
packages. `telemetry`, `sink`, and `source` (with all their adapters, codecs, and
80+
middleware) are released and documented; `broker` is planned. Treat every API as
81+
experimental until it reaches v1.
9082

9183
## Roadmap
9284

@@ -122,22 +114,6 @@ A small set of tools works the IR directly:
122114
Durable state and event persistence is tracked separately with the `durable`
123115
runtime, not here.
124116

125-
## Design & docs
126-
127-
Design rationale, concepts, and guides live on the
128-
[documentation site](https://stablekernel.github.io/crucible/).
129-
130-
Start with:
131-
132-
- [Suite overview & philosophy](https://stablekernel.github.io/crucible/about/overview/):
133-
the suite-wide baseline every module is built to.
134-
- [State machine introduction](https://stablekernel.github.io/crucible/start/introduction/)
135-
- [Concepts: machine & instance](https://stablekernel.github.io/crucible/concepts/machine-and-instance/)
136-
137-
The suite-wide engineering standards are inlined in
138-
[CONTRIBUTING.md](./CONTRIBUTING.md#engineering-standards). For questions or
139-
proposals, open a GitHub issue.
140-
141117
## Contributing
142118

143119
Contributions are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) for dev

0 commit comments

Comments
 (0)