Rewrite README as a short project front page; add a Nix flake

The README is now a landing page: the idea (a mesh VPN with no server, joined
with a network name and a secret), install and platform tables, exit nodes,
and a short build section. Implementation detail stays in docs/.

The flake builds tsng and the tray from source and ships a NixOS module
(services.tsunagi). Dist install notes now show the real `join -n -s` syntax,
and two links that pointed into the old README are redirected.

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Aleksandr BogomiakovandClaude committed 2026-10-03 17:47:44 +01:00
1 parent e6ec62bcba
commit c184ef0914
11 files changed
+434 -725

No files matched your search

+2 -2
View File
@@ -26,8 +26,8 @@ system can hand us IP packets, and even that is behind a trait
| `ManagedTunFactory` | `CAP_NET_ADMIN` | traffic actually reaches the OS |
`ManagedTunFactory` creates the interface and configures it; see
*Provisioning the interface* below and *Privileges* in
[../README.md](../README.md#privileges). With no capability the agent runs
*Provisioning the interface* below and Privileges in
[../dist/linux/README.md](../dist/linux/README.md). With no capability the agent runs
with `--no-tun`: everything but the last hop into the kernel still works.
[boringtun]: https://docs.rs/boringtun