diff --git a/README.md b/README.md new file mode 100644 index 0000000..71e4f99 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Yggdrasil for iOS + +Requires an Apple Developer account for the App Groups and Network Extension entitlements. + +You will need to provision an app group and update bundle IDs throughout the Xcode project as appropriate. + +To build, install Go 1.13 or later, and then install `gomobile`: + +``` +go get golang.org/x/mobile/cmd/gomobile +gomobile init +``` + +Clone the main Yggdrasil repository and build the `Yggdrasil.framework`: + +``` +git clone https://github.com/yggdrasil-network/yggdrasil-go +cd yggdrasil-go +./build -i +``` + +Then copy `Yggdrasil.framework` into the top-level folder of this repository and then build using Xcode.