1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index af4a582..25e1144 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-Work in progress trashbin. Nothing to see here.
+## `IFF_VNET_HDR` for Android
+
+Android's VPN framework does not allow setting `IFF_VNET_HDR` on tun devices.
+This is a simple Zygisk module that sets this flag on tun devices for a
+whitelisted set of packages - `com.wireguard.android` and
+`com.wireguard.android.debug`.
+
+
+### Building
+
+You must have the `ANDROID_HOME` environment variable set and an NDK installed. Simply run:
+
+```
+$ make
+```
+
+Then install `wireguard-vnet-hdr.zip` in Magisk manager.
+
+
+### License
+
+This is a GPLv2 project.