aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2020-11-22 13:48:00 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2020-11-22 22:00:32 +0100
commitb5d75bd59b372c8d0f6a684523e3ab11f6842938 (patch)
treee4dce4295242a9de93c137c11cc8b0656730a9cf /README.md
parentl18n: regenerate index (diff)
downloadwireguard-windows-b5d75bd59b372c8d0f6a684523e3ab11f6842938.tar.xz
wireguard-windows-b5d75bd59b372c8d0f6a684523e3ab11f6842938.zip
docs: add enterprise usage summary
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to '')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index c1e9c835..c4fb88c4 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,14 @@
This is a fully-featured WireGuard client for Windows that uses [Wintun](https://www.wintun.net/).
+### Documentation
+
+In addition to this [`README.md`](README.md), which contains information about building and developing WireGuard for Windows, the following documents are also available:
+
+- [`adminregistry.md`](adminregistry.md) &ndash; A list of registry keys settable by the system administrator for changing the behavior of the application.
+- [`attacksurface.md`](attacksurface.md) &ndash; A discussion of the various components from a security perspective, so that future auditors of this code have a head start in assessing its security design.
+- [`enterprise.md`](enterprise.md) &ndash; A summary of various features and tips for making the application usable in enterprise settings.
+
### Building
Windows 10 64-bit or Windows Server 2019, and Git for Windows is required. The build script will take care of downloading, verifying, and extracting the right versions of the various dependencies: