docs: add client design doc link in README

Signed-off-by: ZhangJian He <shoothzj@gmail.com>
openGemini · Jul 22, 2024 · 0d0cdec · 0d0cdec
1 parent 8aa4636
commit 0d0cdec
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,16 @@
 # opengemini-client-rust
+
+`opengemini-client-rust` is a Rust client for OpenGemini. 
+
+## Language
+
+- English
+- [简体中文](README_CN.md) 
+
+## Design Doc
+
+[OpenGemini Client Design Doc](https://github.com/openGemini/openGemini.github.io/blob/main/src/guide/develop/client_design.md)
+
+## About OpenGemini
+
+OpenGemini is an open-source time series database, find more information [here](https://github.com/openGemini/openGemini)
diff --git a/README_CN.md b/README_CN.md
@@ -0,0 +1,16 @@
+# opengemini-client-rust
+
+`opengemini-client-rust` 是一个用 Rust 语言编写的 OpenGemini 客户端。
+
+## 语言
+
+- [English](README.md)
+- 简体中文
+
+## 设计文档
+
+[OpenGemini Client 设计文档](https://github.com/openGemini/openGemini.github.io/blob/main/src/zh/guide/develop/client_design.md)
+
+## 关于 OpenGemini
+
+OpenGemini 是华为云开源的一款云原生分布式时序数据库。获取更多信息，请点击[这里](https://github.com/openGemini/openGemini)。