From 0f014cf9f37791dce1a10f8c13861630d0b8fdc6 Mon Sep 17 00:00:00 2001 From: Bastian Doetsch Date: Sun, 6 Mar 2022 17:37:44 +0100 Subject: [PATCH] updated README.md with usage information --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 69e9187..1e90544 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,12 @@ Determines the mullvat.net wireguard server with the lowest latency. Download binary from releases for your platform and unpack. ## Usage +### Default 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. +### Extended Output +If you want the full server information, execute `mullvad-best-server -o json`. It returns the full json output of the server information. + ## 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.