From fa70bb976da10e6bad472bc1ba52a65c037ae112 Mon Sep 17 00:00:00 2001
From: Jordan Potter <me@jordanpotter.com>
Date: Thu, 14 Feb 2019 12:00:51 -0800
Subject: [PATCH] Update README with instructions

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d1044f8..20dc248 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
-# docker-wireguard
-Basic container running a wireguard client
+# Wireguard
+This is a simple docker image to run a wireguard client.
+
+Wireguard is implemented as a kernel module, which is key to its performance and simplicity. However, this means that Wireguard _must_ be installed on the host operating system for this container to work properly. Instructions for installing Wireguard can be found [here](http://wireguard.com/install).
+
+You will need a configuration file for your Wireguard interface. Many VPN providers will create this configuration file for you. For example, [here](http://mullvad.net/en/download/wireguard-config) is the configuration generator for Mullvad.
+
+Now simply mount the configuration file and run:
+
+```bash
+docker run --name wireguard \
+    --cap-add=NET_ADMIN 
+    -v /path/to/conf/mullvadus2.conf:/etc/wireguard/mullvadus2.conf
+    jordanpotter/wireguard
+```
+
+Afterwards, you can link other containers to this one:
+
+```bash
+docker run -it --rm
+    --net=container:wireguard
+    appropriate/curl http://httpbin.org/ip
+```