Skip to content

Commit cea66ea

Browse files
authored
docs(readme): grammar fixes (#192)
* docs(readme): grammar fixes Signed-off-by: Frazer Smith <[email protected]> * kill me --------- Signed-off-by: Frazer Smith <[email protected]>
1 parent 59178ee commit cea66ea

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
66

77
Fastify PostgreSQL connection plugin; with this, you can share the same PostgreSQL connection pool in every part of your server.
8-
Under the hood [node-postgres](https://github.com/brianc/node-postgres) is used, the options that you pass to `register` will be passed to the PostgreSQL pool builder.
8+
Under the hood [node-postgres](https://github.com/brianc/node-postgres) is used, and the options that you pass to `register` will be passed to the PostgreSQL pool builder.
99

1010
## Install
1111
```
@@ -150,7 +150,7 @@ fastify.listen({ port: 3000 }, err => {
150150
})
151151
```
152152

153-
As you can see there is no need to close the client, since it is done internally. Promises and async await are supported as well.
153+
As you can see there is no need to close the client since it is done internally. Promises and async await are supported as well.
154154

155155
### Name option
156156
If you need to have multiple databases set up, then you can name each one of them by passing `name: 'foo'`. It will then be accessible as `fastify.pg.foo`.
@@ -182,7 +182,7 @@ fastify.listen({ port: 3000 }, err => {
182182
### Native option
183183
If you want maximum performance you can install [pg-native](https://github.com/brianc/node-pg-native), and pass `native: true` to the plugin options.
184184
*Note: it requires PostgreSQL client libraries & tools installed, see [instructions](https://github.com/brianc/node-pg-native#install).*
185-
Note: trying to use native options without successfully installation of `pg-native` will return a warning and fallback to regular `pg` module.
185+
Note: trying to use native options without successful installation of `pg-native` will return a warning and fallback to the regular `pg` module.
186186

187187
```js
188188
const fastify = require('fastify')()
@@ -208,7 +208,7 @@ fastify.listen({ port: 3000 }, err => {
208208
```
209209

210210
### `pg` option
211-
If you want to provide your own `pg` module, for example to support packages like [`pg-range`](https://www.npmjs.com/package/pg-range), you can provide an optional `pg` option with the patched library to use:
211+
If you want to provide your own `pg` module, for example, to support packages like [`pg-range`](https://www.npmjs.com/package/pg-range), you can provide an optional `pg` option with the patched library to use:
212212

213213
```js
214214
const fastify = require('fastify')()
@@ -307,7 +307,7 @@ $ npm test
307307
DATABASE_TEST_URL="postgres://username:password@localhost/something_thats_a_test_database" npm test
308308
```
309309

310-
## Acknowledgements
310+
## Acknowledgments
311311

312312
This project is kindly sponsored by:
313313
- [nearForm](https://www.nearform.com)

0 commit comments

Comments
 (0)