Merge pull request #104 from JiaweiGithub/feat/doc

Add Chinese readme document
kubeedge · Jul 24, 2023 · 94e97fe · 94e97fe
2 parents 3303352 + 603e949
commit 94e97fe
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+English | [简体中文](./README_zh.md)
+
 # mappers-go
 KubeEdge Device Mappers written in go, it works for KubeEdge 1.4 version and later.
 

diff --git a/README_zh.md b/README_zh.md
@@ -0,0 +1,13 @@
+简体中文 | [English](./README.md)
+
+# mappers-go
+KubeEdge Device Mappers是用go编写的，适用于KubeEdge 1.4或更高版本。
+
+## 快速上手
+如果想把边缘设备连接到kubeedge，可以创建和编写mapper来实现。现提供了两种方式，"mappers"和"mapper-sdk-go"。
+
+### mappers
+Mappers实现了modbus、蓝牙、onvif和opcua。如果想将设备通过这些协议连接到kubeedge，可以在[mappers](./mappers)中找到示例。
+### mapper-go-sdk
+Mapper-sdk-go是一个用go编写的基础框架。基于这个框架，开发人员可以更容易的实现一个新的mapper。Mapper-sdk已实现与KubeEdge的连接，数据转换，管理设备的基本属性和状态等，还提供了驱动程序接口的基本功能和抽象定义。开发人员只需要实现相应设备的自定义协议驱动程序接口，即可实现mapper的功能，
+可以在[mapper-sdk-go](./mapper-sdk-go/)中获取更多详细信息。