diff --git a/README.md b/README.md index 317fee0fc..202c7fb35 100644 --- a/README.md +++ b/README.md @@ -12,44 +12,70 @@ This is why mermaid was born, a simple markdown-like script language for generat The code below would render the following image - - - - - - - - + + + + + + + + + + + + +
CodeRendered diagram
-
-
-graph TD;
-    A-->B;
-    A-->C;
-    B-->D;
-    C-->D;
-
-
-		 -Example 1 -
-
-
-sequenceDiagram
-    participant Alice
-    participant Bob
-    Alice->>John: Hello John, how are you?
-    loop Healthcheck
-        John->>John: Fight against hypochondria
-    end
-    Note right of John: Rational thoughts <br/>prevail...
-    John-->>Alice: Great!
-    John->>Bob: How about you?
-    Bob-->>John: Jolly good!
-
-
-		 -Example 2 -
CodeRendered diagram
+ 
+                
+                    graph TD;
+                        A-->B;
+                        A-->C;
+                        B-->D;
+                        C-->D;
+                
+
+ 		+ Example 1 +
+ 
+                
+                    sequenceDiagram
+                        participant Alice
+                        participant Bob
+                        Alice->>John: Hello John, how are you?
+                        loop Healthcheck
+                        John->>John: Fight against hypochondria
+                        end
+                        Note right of John: Rational thoughts <br/>prevail...
+                        John-->>Alice: Great!
+                        John->>Bob: How about you?
+                        Bob-->>John: Jolly good!
+                
+
+ 		+ Example 2 +
+ 
+                
+                    classDiagram
+                        Class01 <|-- AveryLongClass : Cool
+                        Class03 *-- Class04
+                        Class05 o-- Class06
+                        Class07 .. Class08
+                        Class09 --> C2 : Where am i?
+                        Class09 --* C3
+                        Class09 --|> Class07
+                        Class07 : equals()
+                        Class07 : Object[] elementData
+                        Class01 : size()
+                        Class01 : int chimp
+                        Class01 : int gorilla
+                        Class08 <--> C2: Cool label
+                
+
+ 		+ Example 3 +
## Further reading diff --git a/docs/img/class-diagram.png b/docs/img/class-diagram.png new file mode 100644 index 000000000..e3e234437 Binary files /dev/null and b/docs/img/class-diagram.png differ