+ added uml part in readme

rascafr · Sep 2, 2019 · 4d1e7fd · 4d1e7fd
1 parent 159e03b
commit 4d1e7fd
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8,10 +8,10 @@ This is a quick Node.js project developped to demonstrate how to parse communica
 
 - Decoding address ✅
 - Read ASCI formatted logs ✅
-- Decoding commands and arguments meanings 🔜
+- Decoding commands and arguments meanings ✅
 - Read pure hexfiles logs ✅
 - Group dataframes together
-- Display visual frame transaction sequences 🔜
+- Display visual frame transaction sequences ✅
 - ...
 - Elon Musk on Mars
 
@@ -37,6 +37,25 @@ npm start
 npm run dev
 ```
 
+## UML
+
+PlantUML sequence diagram can be generated using this tool.
+
+You need to download the [PlantUML jar executable](http:https://sourceforge.net/projects/plantuml/files/plantuml.jar/download) on your machine. 
+
+Then, just set the environment variables `PLANTUML_JAR` as the path of the executable.
+
+**Example:** (MacOS / Linux)
+
+```bash
+export PLANTUML_JAR="~/Documents/plantuml.jar"
+```
+
+The generated file will look like:
+
+![](res/uml.png)
+
+
 ## Getting new logs
 
 Use a serial-USB adapter, and use the following settings:

diff --git a/res/uml.png b/res/uml.png