X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=README.md;h=4249251856c6e2da69141cf4f951e2466cfe5e5f;hb=840bfc5fd01bf036344bd687d2e40e0fc19f39e4;hp=d72ed9575cf7385724fbc00831f72712ccb511f7;hpb=bfeab33538d50ee52750de4dd4c0e72b64f674f6;p=src%2Fxds%2Fxds-agent.git

diff --git a/README.md b/README.md
index d72ed95..4249251 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
 # XDS - X(cross) Development System Agent
 
-XDS-agent is a agent that should be run on your local machine when you use XDS.
+XDS-agent is an agent that should run on your local machine when you use XDS.
 
-This agent takes care of starting [Syncthing](https://syncthing.net/) tool to synchronize your projects files from your local machine to build server machine
+This agent takes care of starting [Syncthing](https://syncthing.net/) tool to
+synchronize your projects files from your local machine to build server machine
 or container.
 
 
@@ -14,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.
 
 
@@ -34,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
@@ -50,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)"
     }
 }
 ```