updated README.md with usage information

.github/workflows/go.yml

@@ -9,6 +9,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
 
     - name: Set up Go
       uses: actions/setup-go@v2

README.md

@@ -0,0 +1,17 @@
+# mullvad-best-server
+Determines the mullvat.net wireguard server with the lowest latency. 
+
+## Installation
+
+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.

main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"encoding/json"
+	"flag"
 	"fmt"
 	"github.com/go-ping/ping"
 	"github.com/rs/zerolog"
@@ -17,11 +18,22 @@ var pings = make(map[string]time.Duration)
 
 func main() {
 	zerolog.SetGlobalLevel(zerolog.InfoLevel)
+	var outputFlag = flag.String("o", "short", "Output format. 'json' outputs server json")
+	flag.Parse()
+
 	servers := getServers()
 	bestIndex := selectBestServerIndex(servers)
 	log.Debug().Interface("server", servers[bestIndex]).Msg("Best latency server found.")
 	hostname := strings.Split(servers[bestIndex].Hostname, "-")[0]
-	fmt.Println(hostname)
+	if *outputFlag != "json" {
+		fmt.Println(hostname)
+	} else {
+		serverJson, err := json.Marshal(servers[bestIndex])
+		if err != nil {
+			log.Fatal().Err(err)
+		}
+		fmt.Println(string(serverJson))
+	}
 }
 
 func selectBestServerIndex(servers []server) int {