Updating documentation

Author: lbroudoux

README.md

@@ -8,7 +8,7 @@ It allows to launch tests with minimal dependencies.
 
 Current development version is `0.2.0-SNAPSHOT`. [![Build Status](https://travis-ci.org/microcks/microcks-cli.png?branch=master)](https://travis-ci.org/microcks/microcks-cli)
 
-## Usage instrcutions
+## Usage instructions
 
 Usage is simply `microcks-cli [command]`
 
@@ -46,4 +46,41 @@ $ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ POSTMAN
 MicrocksClient got status for test "5c1781cf6310d94f8169384e" - success: false, inProgress: true
 MicrocksTester waiting for 2 seconds before checking again.
 MicrocksClient got status for test "5c1781cf6310d94f8169384e" - success: true, inProgress: false
+```
+
+### Advanced options
+
+The `test` command provides additional flags for advanced usages and options:
+* `--verbose` allows to dump on standard output all the HTTP requests and responses,
+* `--insecure` allows to interact with Microcks and Keycloak instances through HTTPS without checking certificates issuer CA,
+* `--caCerts=<path1,path2>` allows to specify additional certificates CRT files to add to trusted roots ones,
+* `--operationsHeaders=<JSON>` allows to override some operations headers for the tests to launch.
+
+Overriden test operations headers is a JSON strings where 1st level keys are operation name (eg. `GET /beer`) or `globals` for header applying to all the operations of the API. Headers are specified as an array of objects defining `key` and `values` properties.
+
+Here's below an example of using some of this flags:
+
+```
+./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ POSTMAN \                           
+        --microcksURL=http://localhost:8080/api/ \
+        --keycloakClientId=microcks-serviceaccount \
+        --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 \
+        --insecure --verbose  --waitFor=3sec \
+        --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}'
+```
+
+## Installation
+
+### Binary
+
+Binary releases for Linux, MacOS or Windows platform are available on the GitHub [releases page](https://github.com/microcks/microcks-cli/releases). Just download the binary corresponding to your system and put the binar into the `PATH` somewhere ;-)
+
+### Container image
+
+The `microcks-cli` is now available as a container image as version `0.2.0`. So that you'd be able to easily use it from a GitLab CI or a [Tekton pipeline](https://github.com/tektoncd/pipeline). The hosting repository is now on Docker Hub [here](https://cloud.docker.com/u/microcks/repository/docker/microcks/microcks-cli).
+
+Below a sample on how using the image without getting the CLI binary:
+
+```
+$ docker run -it microcks/microcks-cli:latest microcks-cli test 'Beer Catalog API:0.9' http://beer-catalog-impl-beer-catalog-dev.apps.144.76.24.92.nip.io/api/ POSTMAN --microcksURL=http://microcks.apps.144.76.24.92.nip.io/api/ --keycloakClientId=microcks-serviceaccount --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 --waitFor=8sec  --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}'
 ```