Skip to content

docs(readme): Update README #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025
Merged

docs(readme): Update README #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/gaussdb-cursor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Use a GaussDB result cursor from node with an easy to use API.
```sh
$ npm install gaussdb-cursor
```
___note___: this depends on _either_ `npm install gaussdb` or `npm install gaussdb.js`, but you __must__ be using the pure JavaScript client.
___note___: this depends on _either_ `npm install gaussdb-node` or `npm install gaussdb.js`, but you __must__ be using the pure JavaScript client.

### :star: Documentation :star:

Expand Down
4 changes: 2 additions & 2 deletions packages/gaussdb-pool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A connection pool for gaussdb-node

## install
```sh
npm i gaussdb-pool gaussdb
npm i gaussdb-pool gaussdb-node
```

## use
Expand All @@ -27,7 +27,7 @@ const pool = new Pool()
// and the node-pool (https://github.com/coopernurse/node-pool) constructor
// allowing you to fully configure the behavior of both
const pool2 = new Pool({
database: 'gaussdb-node',
database: 'test_db',
user: 'tset',
password: 'secret!',
port: 5432,
Expand Down
4 changes: 2 additions & 2 deletions packages/gaussdb-query-stream/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Receive result rows from [gaussdb](https://github.com/HuaweiCloudDeveloper/gauss
## installation

```bash
$ npm install gaussdb --save
$ npm install gaussdb-node --save
$ npm install gaussdb-query-stream --save
```

_requires gaussdb>=2.8.1_
_requires gaussdb-node>=0.2.1_

## use

Expand Down