Merge pull request #34 from shengyanli1982/dev

Add design drawings and UML files.
shengyanli1982 · Jul 27, 2024 · 95cab1f · 95cab1f
2 parents 2684bd7 + 0e3fc88
commit 95cab1f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,12 @@ With just two APIs, `Write` and `Stop`, `LAW` offers simplicity and ease of use.
 -   Optimized for efficient garbage collection
 -   Supports customizable action callback functions
 
+# Design
+
+Following the design, the architecture UML diagram for `LAW` is shown below:
+
+![design](assets/architecture.png)
+
 # Installation
 
 ```bash

diff --git a/README_CN.md b/README_CN.md
@@ -28,6 +28,12 @@
 -   优化了垃圾回收
 -   支持操作回调函数
 
+# 设计
+
+根据设计，`LAW` 的架构 UML 图如下所示：
+
+![design](assets/architecture.png)
+
 # 安装
 
 ```bash

diff --git a/architecture.puml b/architecture.puml
diff --git a/assets/architecture.png b/assets/architecture.png