diff --git a/README.md b/README.md index e1f8f3e4b..16320ab73 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![Code Climate](https://codeclimate.com/github/knsv/mermaid/badges/gpa.svg)](https://codeclimate.com/github/knsv/mermaid) [![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) +![](./img/header.png) + 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? @@ -27,7 +29,7 @@ graph TD;

- Example 1 + Flowchart

@@ -42,7 +44,7 @@ sequenceDiagram loop Healthcheck John->>John: Fight against hypochondria end - Note right of John: Rational thoughts <br/>prevail... + Note right of John: Rational thoughts
prevail... John-->>Alice: Great! John->>Bob: How about you? Bob-->>John: Jolly good! @@ -50,7 +52,7 @@ sequenceDiagram - Example 2 + Sequence Diagram diff --git a/img/flow.png b/img/flow.png new file mode 100644 index 000000000..e32429976 Binary files /dev/null and b/img/flow.png differ diff --git a/img/sequence.png b/img/sequence.png new file mode 100644 index 000000000..b35e3b74d Binary files /dev/null and b/img/sequence.png differ