Update README.md

This commit is contained in:
Brian C 2016-06-21 22:10:50 -05:00 committed by GitHub
parent ea141cf16f
commit c00d62169e

View File

@ -22,10 +22,10 @@ Generally you will access the PostgreSQL server through a pool of clients. A cl
var Pool = require('pg').Pool; var Pool = require('pg').Pool;
var config = { var config = {
user: 'foo', //env var: PGUSER user: 'foo',
database: 'my_db', //env var: PGDATABASE password: 'secret',
password: 'secret', //env var: PGPASSWORD database: 'my_db',
port: 5432 //env var: PGPORT port: 5432
}; };
var pool = new Pool(config); var pool = new Pool(config);
@ -50,9 +50,12 @@ pool.connect(function(err, client, done) {
}); });
``` ```
node-postgres uses [pg-pool](https://github.com/brianc/node-pg-pool.git) to manage pooling and only provides a very thin layer on top. It's highly recommend you read the documentation for [pg-pool](https://github.com/brianc/node-pg-pool.git) node-postgres uses [pg-pool](https://github.com/brianc/node-pg-pool.git) to manage pooling and only provides a very thin layer on top.
[Check this out for the get up and running quickly example](https://github.com/brianc/node-postgres/wiki/Example) It's _highly recommend_ you read the documentation for [pg-pool](https://github.com/brianc/node-pg-pool.git)
[Here is a tl;dr get up & running quickly exampe](https://github.com/brianc/node-postgres/wiki/Example)
### Client instance ### Client instance