diff --git a/README.md b/README.md index ba5ceea80..e6431c498 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,46 @@ Ever wanted to simplify documentation and avoid heavy tools like Visio when expl This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript. The code below would render the following image - -``` +
+graph TD; A-->B; A-->C; B-->D; C-->D; -``` - ++ |
+
would render this lovely chart:
-
+![]() |
+
++sequenceDiagram + participant Alice + participant Bob + Alice->John: Hello John, how are you? + loop Healthcheck + John->John: Fight against hypochondria + end + Note right of John: Rational thoughts <br/>prevail... + John-->Alice: Great! + John->Bob: How about you? + Bob-->John: Jolly good! ++ |
+
+would render this lovely chart:
+
+![]() |
+