+## How to run
+
+First 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.
+
+> **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.
+
+## Configuration
+
+xds-agent configuration is driven by a JSON config file (named `agent-config.json`).
+The tarball mentioned in previous section includes this file with default settings.
+
+Here is the logic to determine which `agent-config.json` file will be used:
+1. from command line option: `--config myConfig.json`
+2. `$HOME/.xds/agent-config.json` file
+3. `<current dir>/agent-config.json` file
+4. `<xds-agent executable dir>/agent-config.json` file
+
+Supported fields in configuration file are (all fields are optional and listed
+values are the default values):
+```
+{
+ "httpPort": "8010", # http port of agent REST interface
+ "logsDir": "/tmp/logs", # directory to store logs (eg. syncthing output)
+ "syncthing": {
+ "binDir": ".", # syncthing binaries directory (default: executable directory)
+ "home": "${HOME}/.xds/syncthing-config", # syncthing home directory (usually .../syncthing-config)
+ "gui-address": "http://localhost:8384", # syncthing gui url (default http://localhost:8384)
+ "gui-apikey": "123456789", # syncthing api-key to use (default auto-generated)
+ }
+}
+```
+
+>**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
+
+## Start-up
+
+Simply to start `xds-agent` executable
+```bash
+./xds-agent &
+```
+
+>**NOTE** if need be, you can increase log level by setting option
+`--log <level>`, supported *level* are: panic, fatal, error, warn, info, debug.
+
+You can now use XDS dashboard and check that connection with `xds-agent` is up.
+(see also [xds-server README](https://github.com/iotbzh/xds-server/blob/master/README.md#xds-dashboard))