docs: add design doc links in README

Signed-off-by: PennyYoon <[email protected]>
openGemini · Jul 15, 2024 · 33204c5 · 33204c5
1 parent f39ed79
commit 33204c5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ English | [简体中文](README_CN.md)
 
 OpenGemini is an open-source time series database, find more about OpenGemini at https://github.com/openGemini/openGemini
 
+Find OpenGemini Client design doc at https://github.com/openGemini/openGemini.github.io/blob/main/src/guide/develop/client_design.md
+
 ## Requirements
 
 - Go 1.19

diff --git a/README_CN.md b/README_CN.md
@@ -6,6 +6,8 @@ opengemini-client-go 是一个用 Go 语言编写的 OpenGemini 客户端。
 
 OpenGemini 是华为云开源的一款云原生分布式时序数据库，获取更多关于 OpenGemini 的信息可点击 https://github.com/openGemini/openGemini
 
+查看OpenGemini客户端设计文档，可点击 https://github.com/openGemini/openGemini.github.io/blob/main/src/zh/guide/develop/client_design.md
+
 ## 要求
 
 - Go 1.19