darthsandmann/mullvad-best-server
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated README.md with usage information

Browse Source
This commit is contained in:
Bastian Doetsch
2022-03-06 17:37:44 +01:00
parent 230e89e2b7
commit 0f014cf9f3
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -6,8 +6,12 @@ Determines the mullvat.net wireguard server with the lowest latency.
Download binary from releases for your platform and unpack. Download binary from releases for your platform and unpack.
## Usage ## 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. 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 ## Background
The program uses `https://api.mullvad.net/www/relays/wireguard/` to get the current server list, pings the ones with the right country 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. and outputs the server with the lowest ping.