Skip to content

Commit

Permalink
Update readme.md (#41)
Browse files Browse the repository at this point in the history
Signed-off-by: Poussinou <[email protected]>
Co-authored-by: Revertron <[email protected]>
  • Loading branch information
Poussinou and Revertron authored Nov 25, 2024
1 parent e211111 commit 94db1fa
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -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

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](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

Expand Down

0 comments on commit 94db1fa

Please sign in to comment.