aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2018-04-27 16:45:16 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2018-04-27 16:45:16 +0200
commit9c6f9135e9eda8a9cceebf1eb1980c9b06ce3741 (patch)
treef60fbde71e444b608281b1bd4ccecca9976455e5 /README.md
parentThrow IllegalArgumentExceptions when arguments are bad (diff)
downloadwireguard-android-9c6f9135e9eda8a9cceebf1eb1980c9b06ce3741.tar.xz
wireguard-android-9c6f9135e9eda8a9cceebf1eb1980c9b06ce3741.zip
Add build instructions
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3f221c9c..63bb58a4 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,19 @@
# Android GUI for [WireGuard](https://www.wireguard.com/)
-### [Test this app on the Play Store](https://play.google.com/apps/testing/com.wireguard.android).
+**[Download from the Play Store](https://play.google.com/store/apps/details?id=com.wireguard.android)**
This is an Android GUI for [WireGuard](https://www.wireguard.com/). It [opportunistically uses the kernel implementation](https://git.zx2c4.com/android_kernel_wireguard/about/), and falls back to using the non-root [userspace implementation](https://git.zx2c4.com/wireguard-go/about/).
+## Building
+
+```
+$ git clone https://git.zx2c4.com/wireguard-android
+$ cd wireguard-android
+$ git submodule init
+$ git submodule update
+$ ./gradlew assembleRelease
+```
+
## License
This program is free software; you can redistribute it and/or