updated README.md with badge

.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,18 @@
+# mullvad-best-server
+![Build](https://github.com/bastiandoetsch/mullvad-best-server/actions/workflows/go.yml/badge.svg)
+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,21 +2,38 @@ package main
 
 import (
 	"encoding/json"
+	"flag"
+	"fmt"
 	"github.com/go-ping/ping"
+	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"io"
 	"io/ioutil"
 	"net/http"
+	"strings"
 	"time"
 )
 
 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.Info().Interface("best", servers[bestIndex]).Msg("Best Latency Server found.")
+	log.Debug().Interface("server", servers[bestIndex]).Msg("Best latency server found.")
+	hostname := strings.Split(servers[bestIndex].Hostname, "-")[0]
+	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 {
@@ -69,7 +86,7 @@ func serverLatency(s server) (time.Duration, error) {
 	}
 	var duration time.Duration
 	pinger.OnRecv = func(pkt *ping.Packet) {
-		log.Info().Str("Server", s.Hostname).IPAddr("IP", pkt.IPAddr.IP).Dur("RTT", pkt.Rtt).Msg("Added server latency.")
+		log.Debug().Str("Server", s.Hostname).IPAddr("IP", pkt.IPAddr.IP).Dur("RTT", pkt.Rtt).Msg("Added server latency.")
 		duration = pkt.Rtt
 	}
 	err = pinger.Run()