From a7a37f5320dd2db03e104964ff95c173967fef36 Mon Sep 17 00:00:00 2001 From: pinpox Date: Sat, 25 Oct 2025 12:51:53 +0200 Subject: [PATCH] Update readme --- clanServices/yggdrasil/README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/clanServices/yggdrasil/README.md b/clanServices/yggdrasil/README.md index c639b10cb..54362acaf 100644 --- a/clanServices/yggdrasil/README.md +++ b/clanServices/yggdrasil/README.md @@ -1,7 +1,23 @@ +🚧🚧🚧 Experimental 🚧🚧🚧 + +Use at your own risk. + +We are still refining its interfaces, instability and breakages are expected. + +--- + This module sets up [yggdrasil](https://yggdrasil-network.github.io/) across your clan. -Yggdrasil is designed to be a future-proof and decentralised alternative to -the structured routing protocols commonly used today on the internet. Inside your clan, it will allow you to reach all of your machines. +Yggdrasil is designed to be a future-proof and decentralised alternative to the +structured routing protocols commonly used today on the internet. Inside your +clan, it will allow you to reach all of your machines. + +If you have other services in your inventory which export peers (e.g. the +`internet` or the services) as [service +exports](https://docs.clan.lol/reference/options/clan_service/#exports), they +will be added as yggdrasil peers automatically. This allows using the stable +yggdrasil IPv6 address to refer to other hosts and letting yggdrasil decide on +the best routing based on available connections. ## Example Usage