diff --git a/README.md b/README.md index 820ef39fc06b8d5eabbe3bf7696d65a7cf37916b..5fd26e86a73aad55a6c614b5190f69e0cdedd896 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 - +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. - + diff --git a/Instance.puml b/UML/UML.puml similarity index 100% rename from Instance.puml rename to UML/UML.puml