Merge pull request #8 from happy-game/docs

Docs: Update Documentation

Author: happy-game

CHANGELOG.md

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2010 - 2021 Brian Carlson
+Copyright (c) 2025 happy-game
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,76 +1,66 @@
-# node-postgres
+# gaussdb-node
 
-![Build Status](https://github.com/brianc/node-postgres/actions/workflows/ci.yml/badge.svg)
-<span class="badge-npmversion"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/v/pg.svg" alt="NPM version" /></a></span>
-<span class="badge-npmdownloads"><a href="https://npmjs.org/package/pg" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/pg.svg" alt="NPM downloads" /></a></span>
+<!-- TODO: 打包后再恢复 -->
+<!-- ![Build Status](https://github.com/HuaweiCloudDeveloper/gaussdb-node/actions/workflows/ci.yml/badge.svg)
+<span class="badge-npmversion"><a href="https://npmjs.org/package/gaussdb" title="View this project on NPM"><img src="https://img.shields.io/npm/v/gaussdb.svg" alt="NPM version" /></a></span>
+<span class="badge-npmdownloads"><a href="https://npmjs.org/package/gaussdb" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/gaussdb.svg" alt="NPM downloads" /></a></span> -->
 
-Non-blocking PostgreSQL client for Node.js. Pure JavaScript and optional native libpq bindings.
+Non-blocking GaussDB client for Node.js. Pure JavaScript and optional native libpq bindings.
 
 ## Monorepo
 
-This repo is a monorepo which contains the core [pg](https://github.com/brianc/node-postgres/tree/master/packages/pg) module as well as a handful of related modules.
+This repo is a monorepo which contains the core [gaussdb](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb) module as well as a handful of related modules.
 
-- [pg](https://github.com/brianc/node-postgres/tree/master/packages/pg)
-- [pg-pool](https://github.com/brianc/node-postgres/tree/master/packages/pg-pool)
-- [pg-native](https://github.com/brianc/node-postgres/tree/master/packages/pg-native)
-- [pg-cursor](https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor)
-- [pg-query-stream](https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream)
-- [pg-connection-string](https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string)
-- [pg-protocol](https://github.com/brianc/node-postgres/tree/master/packages/pg-protocol)
+- [gaussdb](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb)
+- [gaussdb-pool](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-pool)
+- [pg-native](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/pg-native)
+- [gaussdb-cursor](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-cursor)
+- [gaussdb-query-stream](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-query-stream)
+- [gaussdb-connection-string](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-connection-string)
+- [gaussdb-protocol](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/packages/gaussdb-protocol)
 
 ## Install
 
 ```
-npm install pg
+npm install gaussdb
 ```
 
 ## Documentation
 
-Each package in this repo should have its own readme more focused on how to develop/contribute. For overall documentation on the project and the related modules managed by this repo please see:
+Each package in this repo should have its own readme more focused on how to develop/contribute. 
+<!-- TODO: 构建文档后恢复 -->
+<!-- For overall documentation on the project and the related modules managed by this repo please see: -->
 
-### :star: [Documentation](https://node-postgres.com) :star:
+### :star: Documentation:star:
 
-The source repo for the documentation is available for contribution [here](https://github.com/brianc/node-postgres/tree/master/docs).
+The source repo for the documentation is available for contribution [here](https://github.com/HuaweiCloudDeveloper/gaussdb-node/tree/master/docs).
 
 ### Features
 
 - Pure JavaScript client and native libpq bindings share _the same API_
 - Connection pooling
-- Extensible JS ↔ PostgreSQL data-type coercion
-- Supported PostgreSQL features
+- Extensible JS ↔ GaussDB data-type coercion
+- Supported GaussDB features
   - Parameterized queries
   - Named statements with query plan caching
-  - Async notifications with `LISTEN/NOTIFY`
   - Bulk import & export with `COPY TO/COPY FROM`
 
 ### Extras
 
-node-postgres is by design pretty light on abstractions. These are some handy modules we've been using over the years to complete the picture.
-The entire list can be found on our [wiki](https://github.com/brianc/node-postgres/wiki/Extras).
+gaussdb-node is by design pretty light on abstractions. These are some handy modules we've been using over the years to complete the picture.
+<!-- TODO: 构建后恢复 -->
+<!-- The entire list can be found on our [wiki](https://github.com/HuaweiCloudDeveloper/gaussdb-node/wiki/Extras). -->
 
 ## Support
 
-node-postgres is free software. If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/brianc/node-postgres). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!
+gaussdb-node is free software. If you encounter a bug with the library please open an issue on the [GitHub repo](https://github.com/HuaweiCloudDeveloper/gaussdb-node). If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear & I will do my best to make it better!
 
 When you open an issue please provide:
 
 - version of Node
-- version of Postgres
+- version of GaussDB
 - smallest possible snippet of code to reproduce the problem
 
-You can also follow me [@briancarlson](https://twitter.com/briancarlson) if that's your thing. I try to always announce noteworthy changes & developments with node-postgres on Twitter.
-
-## Sponsorship :two_hearts:
-
-node-postgres's continued development has been made possible in part by generous financial support from [the community](https://github.com/brianc/node-postgres/blob/master/SPONSORS.md).
-
-If you or your company are benefiting from node-postgres and would like to help keep the project financially sustainable [please consider supporting](https://github.com/sponsors/brianc) its development.
-
-### Featured sponsor
-
-Special thanks to [medplum](https://medplum.com) for their generous and thoughtful support of node-postgres!
-
-![medplum](https://raw.githubusercontent.com/medplum/medplum-logo/refs/heads/main/medplum-logo.png)
 
 ## Contributing
 
@@ -89,14 +79,10 @@ If your change involves breaking backwards compatibility please please point tha
 1. Clone the repo
 2. Ensure you have installed libpq-dev in your system.
 3. From your workspace root run `yarn` and then `yarn lerna bootstrap`
-4. Ensure you have a PostgreSQL instance running with SSL enabled and an empty database for tests
+4. Ensure you have a GaussDB instance running with SSL enabled and an empty database for tests
 5. Ensure you have the proper environment variables configured for connecting to the instance
 6. Run `yarn test` to run all the tests
 
-## Troubleshooting and FAQ
-
-The causes and solutions to common errors can be found among the [Frequently Asked Questions (FAQ)](https://github.com/brianc/node-postgres/wiki/FAQ)
-
 ## License
 
 Copyright (c) 2010-2020 Brian Carlson ([email protected])

README.md

@@ -1,6 +1,6 @@
-# node-postgres docs website
+# gaussdb-node docs
 
-This is the documentation for node-postgres which is currently hosted at [https://node-postgres.com](https://node-postgres.com).
+This is the documentation for gaussdb-node.
 
 ## Development
 

SPONSORS.md

@@ -1,5 +1,4 @@
 {
   "index": "Welcome",
-  "announcements": "Announcements",
   "apis": "API"
 }

docs/README.md

@@ -1,8 +1,8 @@
 {
-  "client": "pg.Client",
-  "pool": "pg.Pool",
-  "result": "pg.Result",
-  "types": "pg.Types",
+  "client": "gaussdb.Client",
+  "pool": "gaussdb.Pool",
+  "result": "gaussdb.Result",
+  "types": "gaussdb.Types",
   "cursor": "Cursor",
   "utilities": "Utilities"
 }