Create README.md

This commit is contained in:
Bastian Doetsch 2022-03-06 17:09:40 +01:00 committed by GitHub
parent 5821d890b8
commit 2998e1d39d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

13
README.md Normal file
View File

@ -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.