Skip to content

Commit

Permalink
docs:modify References format
Browse files Browse the repository at this point in the history
  • Loading branch information
menshibin committed Jan 24, 2025
1 parent 4aec81b commit 36699bc
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
22 changes: 11 additions & 11 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ npm install @tdengine/websocket

## 3. 文档

- 开发示例请见[开发指南](https://docs.taosdata.com/develop/)
- 版本历史、TDengine 对应版本以及 API 说明请见[参考手册](https://docs.taosdata.com/reference/connector/node/)
- 开发示例请见 [开发指南](https://docs.taosdata.com/develop/)
- 版本历史、TDengine 对应版本以及 API 说明请见 [参考手册](https://docs.taosdata.com/reference/connector/node/)

## 4. 前置条件

- 安装 Node.js 开发环境, 使用14以上版本。下载链接: https://nodejs.org/en/download/
- 使用 npm 安装 Node.js 连接器
- 使用 npm 安装 TypeScript 5.3.3 以上版本
- 本地已经部署 TDengine,具体步骤请参考 部署服务端,且已经启动 `taosd``taosAdapter`
- 安装 Node.js 开发环境, 使用14以上版本[下载 Node.js](https://nodejs.org/en/download/)
- 使用 npm 安装 Node.js 连接器
- 使用 npm 安装 TypeScript 5.3.3 以上版本
- 本地已经部署 TDengine,具体步骤请参考 部署服务端,且已经启动 `taosd``taosAdapter`

## 5. 构建

Expand Down Expand Up @@ -91,11 +91,11 @@ Ran all test suites.

我们欢迎提交 [GitHub Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue)。 提交时请说明下面信息:

- 问题描述,是否必现
- Nodejs 版本
- @tdengine/websocket 版本
- 连接参数(不需要用户名密码)
- TDengine 服务端版本
- 问题描述,是否必现
- Nodejs 版本
- @tdengine/websocket 版本
- 连接参数(不需要用户名密码)
- TDengine 服务端版本

## 8. 提交 PR

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Support all platforms that can run Node.js.

## 2. Get the Driver

Install the Node.js connector using npm
Install the Node.js connector using npm.

```shell
npm install @tdengine/websocket
Expand Down Expand Up @@ -93,11 +93,11 @@ Performance testing is in progress.

We welcome the submission of [GitHub Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue). When submitting, please provide the following information:

- Problem description, is it necessary to present it
- Nodejs version
- @tdengine/websocket version
- Connection parameters (no username or password required)
- TDengine Server Version
- Problem description, is it necessary to present it.
- Nodejs version.
- @tdengine/websocket version.
- Connection parameters (no username or password required).
- TDengine Server Version.

## 8. Submitting PRs

Expand All @@ -112,8 +112,8 @@ We welcome developers to contribute to this project. When submitting PRs, please

## 9. References

[TDengine Official Website](https://www.tdengine.com/)
[TDengine GitHub](https://github.com/taosdata/TDengine)
- [TDengine Official Website](https://www.tdengine.com/)
- [TDengine GitHub](https://github.com/taosdata/TDengine)

## 10. License

Expand Down

0 comments on commit 36699bc

Please sign in to comment.