Skip to content

Commit

Permalink
Proposed changes for readme (#1083)
Browse files Browse the repository at this point in the history
  • Loading branch information
IOrlandoni authored and klemmchr committed Nov 20, 2019
1 parent 590c2c4 commit 8364af5
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Expand Up @@ -7,19 +7,9 @@
# mermaid [![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)
<!-- <Main description> -->
__Generate diagrams, charts, graphs or flows from markdown-like text via javascript.__
See our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Play in our [live editor](https://mermaidjs.github.io/mermaid-live-editor/) or jump straight to the installation:
See our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Play in our [live editor](https://mermaidjs.github.io/mermaid-live-editor/) or find the package in **yarn** or **npm** as `mermaid`.

```
yarn add mermaid
```

```
npm install mermaid
```

For more detailed instructions visit our [installation and usage guide](http://mermaid-js.github.io/mermaid/#/usage). Mermaid officially supports the following `Node` versions:
* Node 10
* Node 12
For more detailed instructions visit our [installation and usage guide](http://mermaid-js.github.io/mermaid/#/usage).
<!-- </Main description> -->

:trophy: _"The most exciting use of technology"_ - [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees)
Expand Down

0 comments on commit 8364af5

Please sign in to comment.