diff --git a/docs/README.md b/docs/README.md index 319504284..6d55d650f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,8 @@ # About Mermaid -**Mermaid lets you create diagrams using text and code.** This simplifies the maintenance of complex diagrams. It is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. An alternative to Visio and other Diagramming tools. +**Mermaid lets you create diagrams and visualizations using text and code.** + +It is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. >If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](./n00b-syntaxReference.md). @@ -12,7 +14,7 @@ [![Build Status](https://travis-ci.org/mermaid-js/mermaid.svg?branch=master)](https://travis-ci.org/mermaid-js/mermaid) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Mermaid/mermaid) -The main purpose of Mermaid is to help Documentation catch up with Development. +The main purpose of Mermaid is to help with Visualizing Documentation, and helping it catch up with Development. > Documentation-Rot is a Catch-22 that Mermaid helps to solve. Diagramming and Documentation costs precious developer time and gets outdated quickly.