docs:remove Table of Contents title

taosdata · Jan 24, 2025 · 4aec81b · 4aec81b
1 parent 15f3268
commit 4aec81b
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 65 deletions.
diff --git a/README-CN.md b/README-CN.md
@@ -1,30 +1,32 @@
+<!-- omit in toc -->
 # TDengine Node.js Connector
+<!-- omit in toc -->
 
 | Github Action Tests                                                                  | CodeCov                                                                                                                           |
 |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
 | ![actions](https://github.com/taosdata/taos-connector-node/actions/workflows/push.yaml/badge.svg) | [![codecov](https://codecov.io/gh/taosdata/taos-connector-node/graph/badge.svg?token=5379a80b-063f-48c2-ab56-09564e7ca777)](https://codecov.io/gh/taosdata/taos-connector-node) |
 
 [English](README.md) | 简体中文
 
+<!-- omit in toc -->
 ## 目录
-
-- [TDengine Node.js Connector](#tdengine-nodejs-connector)
-  - [目录](#目录)
-  - [1. 简介](#1-简介)
-    - [1.1 Node.js 版本兼容性](#11-nodejs-版本兼容性)
-    - [1.2 支持的平台](#12-支持的平台)
-  - [2. 获取驱动](#2-获取驱动)
-  - [3. 文档](#3-文档)
-  - [4. 前置条件](#4-前置条件)
-  - [5. 构建](#5-构建)
-  - [6. 测试](#6-测试)
-    - [6.1 运行测试](#61-运行测试)
-    - [6.2 添加用例](#62-添加用例)
-    - [6.3 性能测试](#63-性能测试)
-  - [7. 提交 Issue](#7-提交-issue)
-  - [8.提交 PR](#8提交-pr)
-  - [9. 引用](#9-引用)
-  - [10. 许可证](#10-许可证)
+<!-- omit in toc -->
+
+- [1. 简介](#1-简介)
+  - [1.1 Node.js 版本兼容性](#11-nodejs-版本兼容性)
+  - [1.2 支持的平台](#12-支持的平台)
+- [2. 获取驱动](#2-获取驱动)
+- [3. 文档](#3-文档)
+- [4. 前置条件](#4-前置条件)
+- [5. 构建](#5-构建)
+- [6. 测试](#6-测试)
+  - [6.1 运行测试](#61-运行测试)
+  - [6.2 添加用例](#62-添加用例)
+  - [6.3 性能测试](#63-性能测试)
+- [7. 提交 Issue](#7-提交-issue)
+- [8. 提交 PR](#8-提交-pr)
+- [9. 引用](#9-引用)
+- [10. 许可证](#10-许可证)
 
 
 ## 1. 简介
@@ -67,12 +69,14 @@ npm install @tdengine/websocket
 
 ### 6.1 运行测试
 
-在项目的 `nodejs` 目录下，执行 `npm run test` 命令，即可运行 `test/bulkPulling` 目录中的所有测试用例。这些测试用例将连接本地的 `TDengine` 服务器与 `taosAdapter` 进行相关测试。在终端内将实时输出各测试用例的执行结果。待整个测试流程结束，如果所有用例通过，Failures 和 Errors 都是 0, 并且还会给出相应的覆盖率数据。
+在项目的 `nodejs` 目录下，执行 `npm run test` 命令，即可运行 `test/bulkPulling` 目录中的所有测试用例。这些测试用例将连接本地的 `TDengine` 服务器与 `taosAdapter` 进行相关测试。在终端内将实时输出各测试用例的执行结果。待整个测试流程结束，如果所有用例通过，没有 Failures 和 Errors, 并且还会给出相应的覆盖率数据。
 
 ```text
-[INFO] Results:
-[INFO] 
-[WARNING] Tests run: 2353, Failures: 0, Errors: 0, Skipped: 16
+Test Suites: 8 passed, 8 total
+Tests:       1 skipped, 44 passed, 45 total
+Snapshots:   0 total
+Time:        20.373 s
+Ran all test suites.
 ```
 
 ### 6.2 添加用例
@@ -85,24 +89,24 @@ npm install @tdengine/websocket
 
 ## 7. 提交 Issue
 
-我们欢迎提交 [Github Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue)。 提交时请说明下面信息：
+我们欢迎提交 [GitHub Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue)。 提交时请说明下面信息：
 
 - 问题描述，是否必现
 - Nodejs 版本
 - @tdengine/websocket 版本
 - 连接参数（不需要用户名密码）
 - TDengine 服务端版本
 
-## 8.提交 PR
+## 8. 提交 PR
 
 我们欢迎开发者一起开发本项目，提交 PR 时请参考下面步骤：
 
-1. Fork 本项目，请参考 ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo))
-2. 从 main 分支创建一个新分支，请使用有意义的分支名称 (`git checkout -b my_branch`)。注意不要直接在 main 分支上修改。
-3. 修改代码，保证所有单元测试通过，并增加新的单元测试验证修改。
-4. 提交修改到远端分支 (`git push origin my_branch`)。
-5. 在 Github 上创建一个 Pull Request ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request))。
-6. 提交 PR 后，如果 CI 通过，可以在 [codecov](https://app.codecov.io/gh/taosdata/taos-connector-node/) 页面找到自己分支，看单测覆盖率。
+1. Fork 本项目，请参考 ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo))。
+1. 从 main 分支创建一个新分支，请使用有意义的分支名称 (`git checkout -b my_branch`)。注意不要直接在 main 分支上修改。
+1. 修改代码，保证所有单元测试通过，并增加新的单元测试验证修改。
+1. 提交修改到远端分支 (`git push origin my_branch`)。
+1. 在 GitHub 上创建一个 Pull Request ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request))。
+1. 提交 PR 后，如果 CI 通过，可以在 [codecov](https://app.codecov.io/gh/taosdata/taos-connector-node/pulls) 页面找到自己 PR，看单测覆盖率。
 
 ## 9. 引用
 

diff --git a/README.md b/README.md
@@ -1,30 +1,32 @@
+<!-- omit in toc -->
 # TDengine Node.js Connector
+<!-- omit in toc -->
 
 | Github Action Tests                                                                  | CodeCov                                                                                                                           |
 |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
 | ![actions](https://github.com/taosdata/taos-connector-node/actions/workflows/push.yaml/badge.svg) | [![codecov](https://codecov.io/gh/taosdata/taos-connector-node/graph/badge.svg?token=5379a80b-063f-48c2-ab56-09564e7ca777)](https://codecov.io/gh/taosdata/taos-connector-node) |
 
 English | [简体中文](README-CN.md)
 
+<!-- omit in toc -->
 ## Table of Contents
-
-- [TDengine Node.js Connector](#tdengine-nodejs-connector)
-  - [Table of Contents](#table-of-contents)
-  - [1. Introduction](#1-introduction)
-    - [1.1 Node.js Version Compatibility](#11-nodejs-version-compatibility)
-    - [1.2 Supported Platforms](#12-supported-platforms)
-  - [2. Get the Driver](#2-get-the-driver)
-  - [3. Documentation](#3-documentation)
-  - [4. Prerequisites](#4-prerequisites)
-  - [5. Build](#5-build)
-  - [6. Testing](#6-testing)
-    - [6.1 Test Execution](#61-test-execution)
-    - [6.2 Test Case Addition](#62-test-case-addition)
-    - [6.3 Performance Testing](#63-performance-testing)
-  - [7. Submitting Issues](#7-submitting-issues)
-  - [8. Submitting PRs](#8-submitting-prs)
-  - [9. References](#9-references)
-  - [10. License](#10-license)
+<!-- omit in toc -->
+
+- [1. Introduction](#1-introduction)
+  - [1.1 Node.js Version Compatibility](#11-nodejs-version-compatibility)
+  - [1.2 Supported Platforms](#12-supported-platforms)
+- [2. Get the Driver](#2-get-the-driver)
+- [3. Documentation](#3-documentation)
+- [4. Prerequisites](#4-prerequisites)
+- [5. Build](#5-build)
+- [6. Testing](#6-testing)
+  - [6.1 Test Execution](#61-test-execution)
+  - [6.2 Test Case Addition](#62-test-case-addition)
+  - [6.3 Performance Testing](#63-performance-testing)
+- [7. Submitting Issues](#7-submitting-issues)
+- [8. Submitting PRs](#8-submitting-prs)
+- [9. References](#9-references)
+- [10. License](#10-license)
 
 ## 1. Introduction
 
@@ -48,9 +50,9 @@ npm install @tdengine/websocket
 
 ## 3. Documentation
 
-- For development examples, see the [Developer Guide](https://docs.tdengine.com/developer-guide/).
-- For version history, TDengine version compatibility, and API documentation, see
-  the [Reference Manual](https://docs.tdengine.com/tdengine-reference/client-libraries/node/).
+- For development examples, see [Developer Guide](https://docs.tdengine.com/developer-guide/), which includes examples of data writing, querying, schemaless writing, parameter binding, and data subscription.
+- For other reference information, see [Reference Manual](https://docs.tdengine.com/tdengine-reference/client-libraries/node/), which includes version history, data types, example programs, API descriptions, and FAQs.
+
 
 ## 4. Prerequisites
 
@@ -68,12 +70,14 @@ Execute `tsc` to build the project in the 'nodejs' directory.
 ### 6.1 Test Execution
 
 Execute `npm run test` in the project directory to run the tests. The test cases will connect to the local TDengine server and taosAdapter for testing.
-After running the tests, the result similar to the following will be printed eventually. If all test cases pass, both Failures and Errors will be 0.
+After running the tests, the result similar to the following will be printed eventually. If all test cases pass, without any failures or errors.
 
 ```text
-[INFO] Results:
-[INFO] 
-[WARNING] Tests run: 2353, Failures: 0, Errors: 0, Skipped: 16
+Test Suites: 8 passed, 8 total
+Tests:       1 skipped, 44 passed, 45 total
+Snapshots:   0 total
+Time:        20.373 s
+Ran all test suites.
 ```
 
 ### 6.2 Test Case Addition
@@ -87,7 +91,7 @@ Performance testing is in progress.
 
 ## 7. Submitting Issues
 
-We welcome submitting [Github Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue). Please provide the following information when submitting:
+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
@@ -97,19 +101,19 @@ We welcome submitting [Github Issue](https://github.com/taosdata/taos-connector-
 
 ## 8. Submitting PRs
 
-We welcome developers to develop this project together. When submitting a PR, please refer to the following steps:
+We welcome developers to contribute to this project. When submitting PRs, please follow these steps:
 
-1. Fork this project, please refer to [how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
-2. Create a new branch from the main branch using a meaningful branch name (`git checkout -b my-branch`). Be careful not to modify directly on the main branch.
-3. Modify the code to ensure that all unit tests pass, and add new unit tests to verify the modifications.
-4. Submit modifications to the remote branch (`git push origin my-branch`).
-5. Create a Pull Request on Github ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).
-After submitting the PR, if the CI is approved, it can be done in [codecov](https://app.codecov.io/gh/taosdata/taos-connector-node/) Find your own branch on the page and check the coverage rate of individual tests.
+1. Fork this project, refer to ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
+1. Create a new branch from the main branch with a meaningful branch name (`git checkout -b my_branch`). Do not modify the main branch directly.
+1. Modify the code, ensure all unit tests pass, and add new unit tests to verify the changes.
+1. Push the changes to the remote branch (`git push origin my_branch`).
+1. Create a Pull Request on GitHub ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).
+1. After submitting the PR, if CI passes, you can find your PR on the [codecov](https://app.codecov.io/gh/taosdata/taos-connector-node/pulls) page to check the test coverage.
 
 ## 9. References
 
-- [TDengine Official Website](https://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