diff --git a/README-CN.md b/README-CN.md index ae0037e..804699d 100644 --- a/README-CN.md +++ b/README-CN.md @@ -1,4 +1,4 @@ -# 介绍 +# 简介 | Github Action Tests | CodeCov | |----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -8,6 +8,16 @@ `TDengine.Connector` 是 TDengine 提供的 C# 语言连接器。C# 开发人员可以通过它开发存取 TDengine 集群数据的 C# 应用软件。 +`TDengine.Connector` 提供了两种连接方式: + +- 原生连接:通过客户端驱动程序 taosc 直接与服务端程序 taosd 建立连接。这种方式需要保证客户端的驱动程序 taosc 和服务端的 taosd 版本保持一致。 +- Websocket 连接: 通过 taosAdapter 组件提供的 WebSocket API 建立与 taosd 的连接,不依赖 TDengine 客户端驱动。 + +## 支持的平台 + +- 原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。 +- WebSocket 连接支持所有能运行 .NET 运行时的平台。 + # 获取驱动 可以在当前 .NET 项目的路径下,通过 dotnet CLI 添加 Nuget package `TDengine.Connector` 到当前项目。 diff --git a/README.md b/README.md index d13fc66..400bcdd 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,18 @@ English | [简体中文](README-CN.md) `TDengine.Connector` is the C# language connector provided by TDengine. C# developers can use it to develop C# application software that accesses TDengine cluster data. +`TDengine.Connector` provides two connection methods: + +- Native Connection: Establishes a connection directly with the server program taosd through the client driver taosc. + This method requires the client driver taosc and the server taosd to be of the same version. +- WebSocket Connection: Establishes a connection with taosd through the WebSocket API provided by the taosAdapter + component, without relying on the TDengine client driver. + +## Supported Platforms + +- Native Connection: Supported platforms are consistent with those supported by the TDengine client driver. +- WebSocket Connection: Supports all platforms that can run the .NET runtime. + # Get the Driver Nuget package `TDengine.Connector` can be added to the current project through dotnet CLI under the path of the current .NET project.