mermaid testmermaid

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
index 1bdc876..e0bd6ca 100644
--- a/README.md
+++ b/README.md
@@ -23,3 +23,31 @@ one files using their aforementioned filenames. Any function used by more than
 one of those functions are located in the `format.h` header files. Also, the
 `testsuite.c` provides an easy way to test the library with multiple edge cases
 using data contained in the `testData.h` header file.
+
+# Testing mermaid support on github
+
+This is a sample UML mermaid file:
+
+```mermaid
+classDiagram
+    Animal <|-- Duck
+    Animal <|-- Fish
+    Animal <|-- Zebra
+    Animal : +int age
+    Animal : +String gender
+    Animal: +isMammal()
+    Animal: +mate()
+    class Duck{
+        +String beakColor
+        +swim()
+        +quack()
+    }
+    class Fish{
+        -int sizeInFeet
+        -canEat()
+    }
+    class Zebra{
+        +bool is_wild
+        +run()
+    }
+```