Fix Syncthing package retrieval for Windows

[src/xds/xds-agent.git] / README.md

diff --git a/README.md b/README.md
index 524ad14..4249251 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ used to remotely cross build applications.
 
 ### Dependencies
 
-- Install and setup [Go](https://golang.org/doc/install) version 1.7 or
+- Install and setup [Go](https://golang.org/doc/install) version 1.8 or
 higher to compile this tool.
 
 
@@ -35,6 +35,14 @@ And to install xds-agent in /usr/local/bin:
 make install
 ```
 
+> **NOTE**: To cross build for example for Windows, just execute:
+```bash
+export GOOS=windows
+export GOARCH=amd64
+make all
+make package
+```
+
 ## How to run
 
 ## Configuration
@@ -51,10 +59,12 @@ Supported fields in configuration file are:
 ```json
 {
     "httpPort": "http port of agent REST interface",
+    "logsDir": "directory to store logs (eg. syncthing output)",
     "syncthing": {
         "binDir": "syncthing binaries directory (use xds-agent executable dir when not set)",
         "home": "syncthing home directory (usually .../syncthing-config)",
-        "gui-address": "syncthing gui url (default http://localhost:8384)"
+        "gui-address": "syncthing gui url (default http://localhost:8384)",
+        "gui-apikey": "syncthing api-key to use (default auto-generated)"
     }
 }
 ```