diff --git a/README.md b/README.md new file mode 100644 index 0000000..e474dd1 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# mullvad-best-server +Determines the mullvat.net server with the lowest latency. + +## Installation + +Download binary from releases for your platform and unpack. + +## Usage +Execute `mullvad-best-server`. It outputs the code, e.g. `de05`. You can then connect to it with e.g. wireguard using the normal shell scripts. + +## Background +The program uses `https://api.mullvad.net/www/relays/wireguard/` to get the current server list, pings the ones with the right country +and outputs the server with the lowest ping.