path: root/README.md
diff options
authorJeroen Leenarts <jeroen.leenarts@gmail.com>2018-09-21 20:45:33 +0200
committerJeroen Leenarts <jeroen.leenarts@gmail.com>2018-09-21 20:45:33 +0200
commit8aeca61322ff334840555b028bf732344589c6ac (patch)
tree20531f2962a715ebf40421cf4d1b1c4033e8f9e2 /README.md
parentReport the correct number of rows in the info table view. (diff)
Add some info on that this repository contains.
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'README.md')
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index b7b5123..b532110 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,12 @@
# [WireGuard](https://www.wireguard.com/) for iOS
-To get started...
+This is the sourcecode of the WireGuard iOS app. With this app you should be able to create device wide WireGuard VPN connections.
+Feel free to clone, experiment and modify. Just know that the Network Extension bits will only work on an actual iOS device. To do so, it is required to fully provision both the app and network extension. This is NOT straighforward.
+Get in touch on Freenode IRC channel wireguard.
+## To get started...
Make sure you have Go available. A homebrew install will do. `brew install go`