Add target to get Syncthing and start server script.

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

diff --git a/README.md b/README.md
index 1fb42df..2f068cf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ This powerful webserver (written in [Go](https://golang.org)) exposes a REST
 interface over HTTP and also provides a Web dashboard to configure projects and execute only _(for now)_ basics commands.
 
 XDS-server also uses [Syncthing](https://syncthing.net/) tool to synchronize
-projects files from user machine to build server machine.
+projects files from user machine to build server machine or container.
 
 > **NOTE**: For now, only Syncthing sharing method is supported to synchronize
 projects files.
@@ -28,7 +28,7 @@ xds-server.
 - Install and setup [Go](https://golang.org/doc/install) version 1.7 or
 higher to compile this tool.
 - Install [npm](https://www.npmjs.com/) : `sudo apt install npm`
-- Install [gulp](http://gulpjs.com/) : `sudo npm install -g gulp`
+- Install [gulp](http://gulpjs.com/) : `sudo npm install -g gulp-cli`
 
 
 ### Building
@@ -42,6 +42,11 @@ Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Make
  make all
 ```
 
+And to install xds-server in /usr/local/bin:
+```bash
+make install
+```
+
 ## How to run
 
 ## Configuration
@@ -69,11 +74,14 @@ Supported fields in configuration file are:
 
 ## Start-up
 
+Use `xds-start-server.sh` script to start all requested tools
 ```bash
-./bin/xds-server -c config.json
+/usr/local/bin/xds-start-server.sh
 ```
 
-**TODO**: add notes about Syncthing setup and startup
+>**NOTE** you can define some environment variables to setup for example
+config file `XDS_CONFFILE` or change logs directory `LOGDIR`.
+See head section of `xds-start-server.sh` file to see all configurable variables.
 
 
 ## Debugging
@@ -106,7 +114,7 @@ The server part is written in *Go* and web app / dashboard (client part) in
 +-- webapp/             source client dashboard (Angular2 app)
 ```
 
-VSCode launcher settings can be found into `.vscode/launch.json`.
+Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
 
 
 ## TODO: