From 98ee657447e5c73920b2c1375b928174d2320c50 Mon Sep 17 00:00:00 2001 From: Arceliar Date: Tue, 12 Jun 2018 19:31:36 -0500 Subject: [PATCH] Update README.md Replace some links to the old documentation with links to the .io site --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e44024e..122fd22 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ This is a toy implementation of an encrypted IPv6 network, with many good ideas stolen from [cjdns](https://github.com/cjdelisle/cjdns), which was written to test a particular routing scheme that was cobbled together one random afternoon. It's notably not a shortest path routing scheme, with the goal of scalable name-independent routing on dynamic networks with an internet-like topology. It's named Yggdrasil after the world tree from Norse mythology, because that seemed like the obvious name given how it works. -For a longer, rambling version of this readme with more information, see: [doc](doc/README.md). -A very early incomplete draft of a [whitepaper](doc/Whitepaper.md) describing the protocol is also available. +More information is available at . This is a toy / proof-of-principle, and considered alpha quality by the developers. It's not expected to be feature complete, and future updates may not be backwards compatible, though it should warn you if it sees a connection attempt with a node running a newer version. You're encouraged to play with it, but it is strongly advised not to use it for anything mission critical. @@ -129,11 +128,11 @@ interface eth0 }; ``` -This is enough to give unsupported devices on the LAN access to the yggdrasil network, with a few security and performance cautions outlined in the [doc](doc/README.md) file. +This is enough to give unsupported devices on the LAN access to the yggdrasil network. See the [configuration](https://yggdrasil-network.github.io/configuration.html) page for more info. ## How does it work? -I'd rather not try to explain in the readme, but it is described further in the [doc](doc/README.md) file or the very draft of a [whitepaper](doc/Whitepaper.md), so you can check there if you're interested. +I'd rather not try to explain in the readme, but it is described further on the [about](https://yggdrasil-network.github.io/about.html) page, so you can check there if you're interested. Be warned that it's still not a very good explanation, but it at least gives a high-level overview and links to some relevant work by other people. ## Obligatory performance propaganda