Skip to content

Commit a111da0

Browse files
committed
docs: describe motivation
1 parent 16daebb commit a111da0

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ const connection = await pool.connect();
2727
await pg.query('SELECT $1::text as name', ['foo']);
2828
```
2929

30+
## Motivation
31+
32+
`postgres` is leaner/faster 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).
33+
3034
## Scope
3135

3236
`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.

0 commit comments

Comments
 (0)