From b0f6df871b0601a69dac996f1fce90cc02f42332 Mon Sep 17 00:00:00 2001
From: Felix Scheib <felixscheib@outlook.de>
Date: Mon, 19 Feb 2024 22:59:53 +0100
Subject: [PATCH] ADD: comments added

---
 README.md                     | 10 +++++++---
 Instance.puml => UML/UML.puml |  0
 2 files changed, 7 insertions(+), 3 deletions(-)
 rename Instance.puml => UML/UML.puml (100%)

diff --git a/README.md b/README.md
index 820ef39..5fd26e8 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 ## Mermaid
 
+[Mermaid](https://mermaid.js.org/) can be used to create diagrams like with [Graphviz](https://graphviz.org/) directly embedded into markdown-files.
+
 ```mermaid
   graph TD;
       A-->B;
@@ -8,8 +10,10 @@
       C-->D;
 ```
 
-
 ## PlantUML
+
+[PlantUML](https://plantuml.com/en/) can be used to create UML-diagrams directly embedded into markdown-files.
+
 ```plantuml
 Alice -> Bob: Authentication Request
 Bob --> Alice: Authentication Response
@@ -26,6 +30,6 @@ Car -- Person : < owns
 
 ## Rendered on Webservice
 
-![Class Diagram](http://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/Zingam/Markdown-Document-UML-Use-Test/master/UML/Instance.puml)
+For **public** projects it's possible to let a [webserver](http://www.plantuml.com/plantuml/proxy?src=) render the UML's. This allows to use external files for the defintion of these UML-diagrams.
 
-![Class Diagram](http://www.plantuml.com/plantuml/proxy?src=https://code.fbi.h-da.de/stfeschei/uml-in-markdown/-/raw/main/Instance.puml)
+![Class Diagram](http://www.plantuml.com/plantuml/proxy?src=https://code.fbi.h-da.de/stfeschei/uml-in-markdown/-/raw/main/UML/UML.puml)
diff --git a/Instance.puml b/UML/UML.puml
similarity index 100%
rename from Instance.puml
rename to UML/UML.puml
-- 
GitLab