Add README

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0b5b06f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Wireguard configuration manager
+
+`wgmgr` is a command-line configuration manager for the [Wireguard](https://wireguard.org) VPN solution. It expects a traditional client-server relationship, and cannot be used to handle meshed networks.
+
+It handles client creation and removal, and will auto-generate the corresponding private and public keys. It can also generate the configuration file for each client.
+
+## Setting up
+
+Create the application configuration file, at `/etc/wgmgr.toml`:
+
+```toml
+wgconf = "/etc/wireguard/wg0.conf"  # path to your Wireguard configuration file
+endpoint = 1.2.3.4  # IP address of the server
+port = 6789  # optional, uses 51820 by default
+dns = 8.8.8.8  # optional
+```
+
+Your Wireguard configuration file must already exist and be valid. A sample configuration file is as follows:
+
+```
+[Interface]
+PrivateKey = REDACTED
+ListenPort = 51820
+Address = 10.8.0.1/24
+```
+
+## Reporting bugs
+
+Please report any bugs you find to [bugs+wgmgr@sixfoisneuf.fr](mailto:bugs+wgmgr@sixfoisneuf.fr). Contributions are welcomed, as long as they follow the [git send-email](https://git-send-email.io) format.