Indentation cleanup

[e-mobility-charging-stations-simulator.git] / README.md

diff --git a/README.md b/README.md
index 71112238884c96bb04896c2cbf86f13cdbffbf27..9dce3f0adb22ea576316427f32dfaaf2d6cc50f7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,27 @@
-# charging-stations-simulator
+# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
 
 ## Summary
 
 Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
 
+## Prerequisites
+
+### Windows
+
+* [Chocolatey](https://chocolatey.org/):
+
+```powershell
+choco install -y nodejs-lts
+```
+
+### MacOSX
+
+* [Homebrew](https://brew.sh/):
+
+```shell
+brew install node@14
+```
+
 ## Configuration syntax
 
 All configuration files are in the JSON standard format.  
@@ -36,9 +54,20 @@ logMaxFiles | | 7 | integer | maximum number of log files to keep
 logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
 logFile | | combined.log | string | log file relative path
 logErrorFile | | error.log | string | error log file relative path 
-performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceMeasurements.json" } | { enabled: string; type: string; URI: string; } | performance storage configuration section
+performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceMeasurements.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile', 'mysql', 'mariadb', 'sqlite' or 'mongodb' | performance storage configuration section
 stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
- 
+
+#### Worker process model: 
+
+- **workerSet**:
+  Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
+
+- **staticPool**:
+  Statically sized worker pool executing a static total number of simulated charging stations    
+
+- **dynamicPool**:
+  Dynamically sized worker pool executing a static total number of simulated charging stations 
+
 ### Charging station template
 
 Key | Value(s) | Default Value | Value type | Description 
@@ -220,7 +249,7 @@ make SUBMODULES_INIT=false
 
 #### Remote Trigger Profile
 
-- :x: TriggerMessage
+- :white_check_mark: TriggerMessage
 
 ## OCPP-J standard parameters supported