Write README.md of the demo project

ajfAfg · Feb 27, 2024 · bf8b9d3 · bf8b9d3
1 parent d61f249
commit bf8b9d3
Show file tree

Hide file tree

Showing 2 changed files with 172 additions and 6 deletions.
diff --git a/demo/README.md b/demo/README.md
@@ -1,9 +1,20 @@
-demo
-=====
+# bean demo project
 
-An OTP application
+This project is a simple demonstration of bean.
 
-Build
------
+## gen_servers and the supervision tree automatically generated for them
 
-    $ rebar3 compile
+In this project, gen_servers are defined in [src/gen_servers](src/gen_servers) directory. The following figure shows the dependencies of the gen_servers:
+
+```mermaid
+graph LR
+    third_server --> second_server
+    second_server --> first_server
+    fib_server
+    fizzbuzz_server
+
+```
+
+Then bean generates the supervision tree shown in the following figure:
+
+![Generated supervision tree](./generated_supervision_tree.drawio.svg)
diff --git a/demo/generated_supervision_tree.drawio.svg b/demo/generated_supervision_tree.drawio.svg