X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fafb-tests-overview.md;h=d6f619fec5289a3678f93bbc91c9997af2428522;hb=8342fcc144bd8f1d9a24c1a018c15440dd43481d;hp=a4632d49a2fc0c890ffb8018e270f9084c3123a8;hpb=d73846c8868be1098fb75df83521ba34cfbcad16;p=src%2Fapp-framework-binder.git

diff --git a/doc/afb-tests-overview.md b/doc/afb-tests-overview.md
index a4632d49..d6f619fe 100644
--- a/doc/afb-tests-overview.md
+++ b/doc/afb-tests-overview.md
@@ -1,38 +1,46 @@
-# Overview of tests shipped with AFB-Daemon
-    Version: 1
-    Date:    30 May 2016
-    Author:  Manuel Bachmann
 
+Overview of tests shipped with AFB-Daemon
+=========================================
 
-## List of tests
-  Here are the tests shipped in the source tree:
- * **afb-client-demo** (command-line WebSockets)
- * **token-websock.qml** (Qt/QML WebSockets)
- * ***.html** (HTML5/JS HTTP-REST & WebSockets)
+List of tests
+-------------
 
+Here are the tests shipped in the source tree:
 
-## Detail of tests
+* **afb-client-demo** (command-line WebSockets)
+
+* **token-websock.qml** (Qt/QML WebSockets)
+
+* ***.html** (HTML5/JS HTTP-REST & WebSockets)
+
+
+Detail of tests
+---------------
 
 ### afb-client-demo (command-line WebSockets)
 
-This clients interactively calls plugins APIs from the command line, using the binder [WebSockets](https://en.wikipedia.org/wiki/WebSocket) facility.
+This clients interactively calls bindings APIs from the command line, using the binder
+[WebSockets](https://en.wikipedia.org/wiki/WebSocket) facility.
 
 If _afb-daemon_ has been launched with the following parameters:
-```
-$ afb-daemon --port=1234 --token=123456 [...]
-```
+
+
+    $ afb-daemon --port=1234 --token=123456 [...]
+
 
 Then run the client with :
-```
-afb-client-demo ws://localhost:1234/api?token=123456 <plugin> <verb>
-```
 
-For instance, to initialize the Audio plugin from the command line :
-```
-afb-client-demo ws://localhost:1234/api?token=123456 auth connect
-(copy-paste the "token" field from the response)
-afb-client-demo ws://localhost:1234/api?token=123456 audio init <TOKEN>
-```
+    afb-client-demo ws://localhost:1234/api?token=123456 [<api> <verb> [<json-data>]]
+
+For instance, to initialize the Audio binding from the command line :
+
+    afb-client-demo ws://localhost:1234/api?token=123456
+
+The command doesn't return. You should type requests of type <api> <verb> [<json-data>].
+So, try:
+
+    auth connect
+    hello pingjson true
 
 <br />
 
@@ -41,22 +49,24 @@ afb-client-demo ws://localhost:1234/api?token=123456 audio init <TOKEN>
 ### token-websock.qml (Qt/QML WebSockets)
 
 If _afb-daemon_ has been launched with the following parameters:
-```
-$ afb-daemon --port=1234 --token=123456 [...]
-```
-and Qt5 is installed, on **Ubuntu 16.04**:
-```
-$ apt-get install qmlscene qml-module-qtwebsockets qml-module-qtquick-controls
-```
-or on **Fedora 23** :
-```
-$ dnf install qt5-qtdeclarative-devel qt5-qtwebsockets-devel qt5-qtquickcontrols
-```
+
+    $ afb-daemon --port=1234 --token=123456 [...]
+
+and Qt5 is installed.
+
+For installing Qt5 on **Ubuntu 16.04**:
+
+    $ apt-get install qmlscene qml-module-qtwebsockets qml-module-qtquick-controls
+
+For installing Qt5 on **Fedora >= 22** :
+
+    $ dnf install qt5-qtdeclarative-devel qt5-qtwebsockets-devel qt5-qtquickcontrols
+
 
 Then run the client with :
-```
-qmlscene test/token-websock.qml
-```
+
+    qmlscene test/token-websock.qml
+
 and interactively press the buttons, "Connect", "Refresh", "Logout".
 
 <br />
@@ -65,14 +75,15 @@ and interactively press the buttons, "Connect", "Refresh", "Logout".
 ### *.html (HTML5/JS HTTP-REST & WebSockets)
 
 If _afb-daemon_ has been launched with the following parameters:
-```
-$ afb-daemon --port=1234 --rootdir=$PWD/test [...]
-```
+
+    $ afb-daemon --port=1234 --rootdir=$PWD/test [...]
+
 _("$PWD/test_" being the "test" subdirectory of the source tree)_
 
 
 Then open your preferred Web browser, connect to the following URL:
-```
-http://localhost:1234
-```
+
+    http://localhost:1234
+
 and interactively run the various tests.
+