Fix missing tools path creation.
[src/xds/xds-agent.git] / README.md
index d72ed95..ad8e6bb 100644 (file)
--- 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.
 
 
@@ -50,10 +51,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)"
     }
 }
 ```