cwinfo/yggdrasil-go
5
0
Fork 0
mirror of https://github.com/cwinfo/yggdrasil-go.git synced 2024-11-24 14:51:36 +00:00
Code Releases Activity

Update README.md

Browse Source
This commit is contained in:
Neil Alexander 2021-07-02 23:24:34 +01:00
parent 4d47ba8bf4
commit f7b91a8f93
1 changed files with 5 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -11,23 +11,14 @@ allows pretty much any IPv6-capable application to communicate securely with
other Yggdrasil nodes. Yggdrasil does not require you to have IPv6 Internet other Yggdrasil nodes. Yggdrasil does not require you to have IPv6 Internet
connectivity - it also works over IPv4. connectivity - it also works over IPv4.
Although Yggdrasil shares many similarities with
[cjdns](https://github.com/cjdelisle/cjdns), it employs a different routing
algorithm based on a globally-agreed spanning tree and greedy routing in a
metric space, and aims to implement some novel local backpressure routing
techniques. In theory, Yggdrasil should scale well on networks with
internet-like topologies.
## Supported Platforms ## Supported Platforms
Yggdrasil works on a number of platforms, including Linux, macOS, Ubiquiti Yggdrasil works on a number of platforms, including Linux, macOS, Ubiquiti
EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt. EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt.
Please see our [Installation](https://yggdrasil-network.github.io/installation.html) Please see our [Installation](https://yggdrasil-network.github.io/installation.html)
page for more information. page for more information. You may also find other platform-specific wrappers, scripts
or tools in the `contrib` folder.
You may also find other platform-specific wrappers, scripts or tools in the
`contrib` folder.
## Building ## Building
@ -83,10 +74,10 @@ by giving the Yggdrasil binary the `CAP_NET_ADMIN` capability.
## Documentation ## Documentation
Documentation is available on our [GitHub Pages](https://yggdrasil-network.github.io) Documentation is available [on our website](https://yggdrasil-network.github.io).
site.
- [Configuration file](https://yggdrasil-network.github.io/configuration.html) - [Installing Yggdrasil](https://yggdrasil-network.github.io/installation.html)
- [Configuring Yggdrasil](https://yggdrasil-network.github.io/configuration.html)
- [Frequently asked questions](https://yggdrasil-network.github.io/faq.html) - [Frequently asked questions](https://yggdrasil-network.github.io/faq.html)
- [Version changelog](CHANGELOG.md) - [Version changelog](CHANGELOG.md)