Skip to content

Commit 5a3ac0d

Browse files
committed
docs: reword compatibility section
1 parent cb7076c commit 5a3ac0d

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

README.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,13 @@ await pg.query('SELECT $1::text as name', ['foo']);
3131

3232
## Motivation
3333

34-
`postgres` is leaner/[faster](https://github.com/porsager/postgres-benchmarks) implementation of PostgreSQL protocol in Node.js than `pg`. However, `postgres` API is very different from the more broadly adopted [`pg` client](https://www.npmjs.com/package/pg). This package allows to adopt `postgres` without going through a painful migration. In particular, this compatibility layer has been designed to allow adoption of `postgres` using [Slonik PostgreSQL client](https://www.npmjs.com/package/slonik).
34+
`postgres` is leaner/[faster](https://github.com/porsager/postgres-benchmarks) implementation of PostgreSQL protocol in Node.js than `pg`. However, `postgres` API is very different from the more broadly adopted [`pg` client](https://www.npmjs.com/package/pg).
3535

36-
## Scope
36+
This package allows to adopt `postgres` without going through a painful migration. In particular, this compatibility layer has been designed to allow adoption of `postgres` using [Slonik PostgreSQL client](https://www.npmjs.com/package/slonik).
3737

38-
`postgres-bridge` is limited to the API that is consumed by [Slonik PostgreSQL client](https://www.npmjs.com/package/slonik), i.e. Using `postgres-bridge` you are able to use [`postgres`](https://www.npmjs.com/package/postgres) with Slonik.
39-
40-
Supported features:
38+
## Compatibility
4139

42-
* `pool.connect`
43-
* `connection.query`
44-
* `connect` event
45-
* `remove` event
46-
* `notice` event
40+
`postgres-bridge` is limited to the API that is consumed by [Slonik PostgreSQL client](https://www.npmjs.com/package/slonik), i.e. Using `postgres-bridge` you are able to use [`postgres`](https://www.npmjs.com/package/postgres) with Slonik.
4741

4842
Known incompatibilities:
4943

0 commit comments

Comments
 (0)