Rework search directories for agent-config.json files.

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

diff --git a/README.md b/README.md
index 4cdf5ae..312ffd1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -67,13 +67,9 @@ The files are install here:
 
 ## How to install on other platform
 
-You need to download `xds-agent` tarballs from xds dashboard by clicking
-on download icon ![download icon](./resources/images/download_icon.jpg) of
-configuration page.
+Download released tarballs from github [releases page](https://github.com/iotbzh/xds-agent/releases).
 
-> **NOTE** : you can also download released tarballs from github [releases page](https://github.com/iotbzh/xds-agent/releases).
-
-Then unzip this tarball any where into your local disk.
+Then unzip this tarball any where into your local disk (for example: /opt/AGL/xds or C:\AGL\xds).
 
 ## Configuration
 
@@ -83,8 +79,8 @@ The tarball mentioned in previous section includes this file with default settin
 Here is the logic to determine which `agent-config.json` file will be used:
 
 1. from command line option: `--config myConfig.json`
-1. `$HOME/.xds/agent-config.json` file
-1. `<current dir>/agent-config.json` file
+1. `$HOME/.xds/agent/agent-config.json` file
+1. `/etc/xds-agent/agent-config.json` file
 1. `<xds-agent executable dir>/agent-config.json` file
 
 Supported fields in configuration file are (all fields are optional and example
@@ -105,7 +101,7 @@ below corresponds to the default values):
     "xds-apikey": "1234abcezam",
     "syncthing": {
         "binDir": ".",
-        "home": "${HOME}/.xds/syncthing-config",
+        "home": "${HOME}/.xds/agent/syncthing-config",
         "gui-address": "http://localhost:8384",
         "gui-apikey": "1234abcezam",
     }