DOC: Update README.md

Author: mjuraga

README.md

@@ -4,9 +4,9 @@
 
 **Data Plane API** is a sidecar process that runs next to HAProxy and provides API endpoints for managing HAProxy. It requires HAProxy version 1.9.0 or higher.
 
-## API Specification
+## API Specification - Development guide
 
-Data Plane API is built using [go-swagger](https://github.com/go-swagger/go-swagger) from the swagger spec found [here](https://github.com/haproxytech/dataplaneapi-specification/blob/master/build/haproxy_spec.yaml) using the following command.
+Data Plane API is generated using [go-swagger](https://github.com/go-swagger/go-swagger) from the swagger spec found [here](https://github.com/haproxytech/dataplaneapi-specification/blob/master/build/haproxy_spec.yaml) using the following command.
 
 ```
 ./swagger generate server -f haproxy_spec.yaml \
@@ -38,10 +38,11 @@ Data Plane API is built using [go-swagger](https://github.com/go-swagger/go-swag
     --tags=StickRule \
     --tags=LogTarget \
     --tags=Reloads \
-    --tags=ACL
+    --tags=ACL \
+    --tags=Defaults
 ```
 
-This command generates some of the files in this project, which are marked with //DO NOT EDIT comments at the top of the files. These are not to be edited, as they are overwritten when specification is changed and the above-mentioned command is run.
+This command generates some of the files in this project, which are marked with //DO NOT EDIT comments at the top of the files. These are not to be edited, as they are overwritten when specification is changed and the above-mentioned command is run. If you want to change those files, please change the specification and then generate them again.
 
 ## Dependencies
 
@@ -64,41 +65,37 @@ External dependecies:
 - [mapstructure](https://github.com/mitchellh/mapstructure)
 - [crypt](https://github.com/GehirnInc/crypt)
 
-## Building
+## Building the Data Plane API
 
-Following steps are required for building:
-
-1\. Set your GOPATH variable
-
-2\. Clone dataplaneapi repository into $GOPATH/src/github.com/haproxytech
+1\. Clone dataplaneapi repository into $GOPATH/src/github.com/haproxytech
 
 ```
 cd $GOPATH/src/github.com/haproxytech
 git clone https://github.com/haproxytech/dataplaneapi.git
 ```
 
-3\. Run make build:
+2\. Run make build:
 
 ```
 make build
 ```
 
-4\. You can find the built binary in $GOPATH/bin directory.
+3\. You can find the built binary in /build directory.
 
 ## Running the Data Plane API
 
 Basic usage:
 
 ```
-./dataplaneapi --help
 Usage:
   dataplaneapi [OPTIONS]
 
 API for editing and managing haproxy instances
 
 Application Options:
       --scheme=                                    the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec
-      --cleanup-timeout=                           grace period for which to wait before shutting down the server (default: 10s)
+      --cleanup-timeout=                           grace period for which to wait before killing idle connections (default: 10s)
+      --graceful-timeout=                          grace period for which to wait before shutting down the server (default: 15s)
       --max-header-size=                           controls the maximum number of bytes the server will read parsing the request header's keys and values, including the request line. It does not limit the size of the request body. (default: 1MiB)
       --socket-path=                               the unix socket to listen on (default: /var/run/data-plane.sock)
       --host=                                      the IP to listen on (default: localhost) [$HOST]
@@ -110,7 +107,7 @@ Application Options:
       --tls-host=                                  the IP to listen on for tls, when not specified it's the same as --host [$TLS_HOST]
       --tls-port=                                  the port to listen on for secure connections, defaults to a random value [$TLS_PORT]
       --tls-certificate=                           the certificate to use for secure connections [$TLS_CERTIFICATE]
-      --tls-key=                                   the private key to use for secure conections [$TLS_PRIVATE_KEY]
+      --tls-key=                                   the private key to use for secure connections [$TLS_PRIVATE_KEY]
       --tls-ca=                                    the certificate authority file to be used with mutual tls auth [$TLS_CA_CERTIFICATE]
       --tls-listen-limit=                          limit the number of outstanding requests
       --tls-keep-alive=                            sets the TCP keep-alive timeouts on accepted connections. It prunes dead TCP connections ( e.g. closing laptop mid-download)
@@ -121,7 +118,7 @@ HAProxy options:
   -c, --config-file=                               Path to the haproxy configuration file (default: /etc/haproxy/haproxy.cfg)
   -u, --userlist=                                  Userlist in HAProxy configuration to use for API Basic Authentication (default: controller)
   -b, --haproxy-bin=                               Path to the haproxy binary file (default: haproxy)
-  -d, --reload-delay=                              Minimum delay between two reloads (in s)
+  -d, --reload-delay=                              Minimum delay between two reloads (in s) (default: 5)
   -r, --reload-cmd=                                Reload command
       --reload-retention=                          Reload retention in days, every older reload id will be deleted (default: 1)
   -t, --transaction-dir=                           Path to the transaction directory (default: /tmp/haproxy)
@@ -133,6 +130,9 @@ Logging options:
       --log-level=[trace|debug|info|warning|error] Logging level (default: warning)
       --log-format=[text|JSON]                     Logging format (default: text)
 
+Show version:
+  -v, --version                                    Version and build information
+
 Help Options:
   -h, --help                                       Show this help message
 ```