aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-17 13:04:22 +0000
committertv <tv@krebsco.de>2026-11-17 14:22:50 +0100
commitb7771be595b76cfa26540acda5234bdefa0c4e54 (patch)
treedcad178c1c3338f56775ffbed51eea3599218095 /README.md
parent10995f1dadbb0ab739b96d970cb0a58e2701b4c6 (diff)
guides: getting started with a federation
`docs/guides/federation/` holds the guides to a federated swarm, the design saying what the rules are and they how to live by them. The first: two parties start a federation, a node each, write, read, and let a third party in by their votes. The README points to them.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 179141f..21d0cf7 100644
--- a/README.md
+++ b/README.md
@@ -92,11 +92,12 @@ curl -u alice:secret localhost:3000/peers # who is out there
* [`docs/trust.md`](docs/trust.md): who can do what.
* [`docs/access.md`](docs/access.md): users, and what each may do.
* [`docs/federation.md`](docs/federation.md): a design for a swarm kept by parties that
- don't trust each other. Not built.
+ don't trust each other, built behind the `federation` feature;
+ [`docs/guides/federation/`](docs/guides/federation/): how to start, run and use one.
* [`docs/store.md`](docs/store.md): a design for a store of events, each judged where it
- was written, generic over what they read as; the federation rests on it. Not built.
+ was written, generic over what they read as; the federation rests on it.
* [`docs/federation-tests.md`](docs/federation-tests.md): how the store and the
- federation are to be tested. Not built.
+ federation are tested.
* [`docs/topology.md`](docs/topology.md): who syncs with whom, and how a change passes on: the
choices, which combine well, and what they cost.
* [`docs/measurements.md`](docs/measurements.md): `/admin/stats` and its Prometheus metrics.