From a8e4d37c1374278b5bf8ed09dc25c2b032b373bc Mon Sep 17 00:00:00 2001 From: Knut Sveidqvist Date: Sun, 2 Nov 2014 01:01:23 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b31939567..e41d2d34b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ mermaid ======= -Generation of diagram and flowchart from text in a similar manner as markdown +Generation of diagram and flowchart from text in a similar manner as markdown. + +Ever wanted to simplify documentation and avoid heavy tools like visio when explaining your code? + +This is why I came up with mermaid, a simple markdown-like script language for generating charts from text via javascript. + +`A --> B + +A --> C + +B-->D + +C-->D`