From 81accee7af91abd1e4a9275cd03fe2df0d76cb25 Mon Sep 17 00:00:00 2001 From: Poussinou Date: Sat, 17 Dec 2022 14:06:47 +0930 Subject: [PATCH] Update readme.md Signed-off-by: Poussinou --- readme.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 69fe52e..98e1bc2 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,23 @@ -## build instructions +Yggdrasil Android +----------------- + +Yggdrasil is an early-stage implementation of a fully end-to-end encrypted IPv6 network. It is lightweight, self-arranging, supported on multiple platforms and allows pretty much any IPv6-capable application to communicate securely with other Yggdrasil nodes. Yggdrasil does not require you to have IPv6 Internet connectivity - it also works over IPv4. + +This app allows you to connect to Yggdrasil Network and use any service located in this network. It works as VPN service, but all your usual traffic will go trough your provider, not through Yggdrasil Network. + +Also, it is not a goal of the Yggdrasil project to provide anonymity. Direct peers over the Internet will be able to see your IP address and may be able to use this information to determine your location or identity. Multicast-discovered peerings on the same network will typically expose your device MAC address. Other nodes on the network may be able to discern some information about which nodes you are peered with. + +All traffic sent across the Yggdrasil network is encrypted end-to-end. Assuming that our crypto is solid, it cannot be decrypted or read by any intermediate nodes, and can only be decrypted by the recipient for which it was intended. However, please note that Yggdrasil has not been officially externally audited. + +## Download + +[Get it on F-Droid](https://f-droid.org/packages/eu.neilalexander.yggdrasil/) + +Or get the APK from the [Releases Section](https://github.com/yggdrasil-network/yggdrasil-android/releases/latest). + +## Build Instructions * install gomobile