From deccf8891da9e43c1d6fbb9ef549a58085da15f5 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Mon, 13 Jul 2020 14:56:24 -0700 Subject: [PATCH] Update README.md --- docs/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 644cd8027..9e7bcac90 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,13 +5,14 @@ [![Join the chat at https://gitter.im/knsv/mermaid](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/knsv/mermaid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![banner](./img/header.png) -**Edit this Page** [![N|Solid](./img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/edit/release/8.6.0/docs/README.md) +**Edit this Page** [![N|Solid](./img/GitHub-Mark-32px.png)](./README.md) -Generation of diagrams and flowcharts from text in a similar manner as markdown. -Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code? +Mermaid is a tool that generates diagrams and charts, from markdown-inspired text definitions -This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript. +Have you ever wanted to simplify the generation and updating of your diagrams and charts, while avoiding time-intensive and heavy tools like visio? + +This is why mermaid was born, a simple markdown-inspired script language for generating charts from text-definitions, via javascript. Check out the list of [Integrations and Usages of Mermaid](./integrations.md)