Browse Source

Update of documentation

Jérôme BUISINE 1 year ago
parent
commit
1c4b135aef
1 changed files with 10 additions and 0 deletions
  1. 10 0
      README.md

+ 10 - 0
README.md

@@ -176,5 +176,15 @@ yarn doc
 ```
 The documentation is generated to the `doc/` directory. If you started the server, the documentation is served at `/doc/`.
 
+## Collected DATA
+
+During application use a lot of data is collected by platform, here a description of main message identifier used:
+
+- COLLECT_DATA: specify that the collected data process began.
+- EXPERIMENT_STARTED: message which is used for start of an experiment.
+- EXPERIMENT_DATA: message for data of an experiment.
+- EXPERIMENT_VALIDATED: end of experiences message.
+
 ## License
+
 [The MIT license](LICENSE)