mirrors
/
mermaid
mirror of https://github.com/mermaid-js/mermaid.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Neil Cuzon 2020-02-29 00:07:47 -08:00 committed by GitHub
parent cda41a1506
commit 5693c69457
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/README.md
View File

@ -6,11 +6,12 @@
![banner](./img/header.png)
# What is mermaid?
mermaid offers the capacity to generate diagrams and charts from markdown inspired text.
The reasoning behind it's inception was a need for simplified documentation and frustration with heavy and time consuming tools like Visio, for explaining code?
It is a simple markdown-inspired, script language for diagramming and charting that can be deployed via Javascipt.
Thus a simple markdown-inspired, script language for diagramming and charting, via javascript was made.
The reasoning behind it's inception was a need for simplified documentation and frustration with heavy and time consuming tools like Visio, for explaining code.
Thus mermaid was created to make the process of diagramming and charting, as simple and as close to markdown, as possible.
Check out the list of [Integrations and Usages of Mermaid](./integrations.md)
For the uninitiated, you can also try out our [live editor](https://mermaid-js.github.io/mermaid-live-editor/) and look at our [documentation](https://mermaid-js.github.io/mermaid/#/n00b-overview) for a deeper understanding of the tool itself, more importantly don't forget to have fun.