improved UML documentation

README.md

@@ -63,4 +63,37 @@ This script should be updated to be ran from anywhere.
 
 # More documentation
 
-[Visit the docs/ directory](/docs/)
+[Visit the docs/ directory](/docs/)
+
+## UML
+
+We are currently using  [goplantuml](https://github.com/jfeliu007/goplantuml/) to generate the oject diagrams directly from the go files. This tools creates `.plums` files directly from the directory where the go files are located. These UML files can then be visualized using plantuml and the VS Code extensions plantuml.
+
+**Setting up the plantuml environment** :
+
+```
+# Downloading the go tool goplantuml
+go get github.com/jfeliu007/goplantuml/parser
+go install github.com/jfeliu007/goplantuml/cmd/goplantuml@latest
+
+# Install the plantuml environment
+sudo apt install default-jre
+sudo apt install plantuml
+
+```
+**Rich PlantUML extension Link**: https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml or search it in the marketplace panel of VS Code
+
+**Generate and view an UML diagram**
+
+```
+goplantuml path/to/code/directory > path/to/dest/file.puml
+```
+
+- open the .puml file generated
+- alt + d to have the extension preview the plantUML code
+- right click inside the .puml and select 'Export Current Diagram' to create an image file
+- the output will be generated in a `out/` directory in the current path
+
+### Note 
+
+Only `.puml` files ought to be commited to the git repository, because their nature allows to track changes, while image file do not fit the purpose of versioning.