aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides/federation/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 /docs/guides/federation/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 'docs/guides/federation/README.md')
-rw-r--r--docs/guides/federation/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/guides/federation/README.md b/docs/guides/federation/README.md
new file mode 100644
index 0000000..5a6b227
--- /dev/null
+++ b/docs/guides/federation/README.md
@@ -0,0 +1,8 @@
+# Guides to a federated swarm
+
+How to start, run and use a swarm kept by parties that don't trust each other. The design
+([`federation.md`](../../federation.md)) says what the rules are; these say how to live
+by them, in its words.
+
+* [`getting-started.md`](getting-started.md): two parties start a federation, write,
+ read, and let a third one in.