Skip to content

Commit aec3407

Browse files
committed
Update README.md
1 parent 1b61e16 commit aec3407

File tree

1 file changed

+13
-25
lines changed

1 file changed

+13
-25
lines changed

README.md

+13-25
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,12 @@ PostgreSQL client for node.js. Pure JavaScript and native libpq bindings.
88

99
npm install pg
1010

11-
### Windows
12-
13-
1. Install Visual Studio C++ (successfully built with Express 2010). Express is free.
14-
2. Add your Postgre Installation's `bin` folder to the system path (i.e. `C:\Program Files\PostgreSQL\9.3\bin`).
15-
3. Make sure that both `libpq.dll` and `pg_config.exe` are in that folder.
16-
4. `npm install pg`
1711

1812
## Examples
1913

2014
### Client pooling
2115

22-
Typically you will access the PostgreSQL server through a pool of clients. node-postgres ships with a built in pool to help get you up and running quickly.
16+
Generally you will access the PostgreSQL server through a pool of clients. A client takes a non-trivial amount of time to establish a new connection. A client also consumes a non-trivial amount of resources on the PostgreSQL server - not something you want to do on every http request. Good news: node-postgres ships with built in client pooling.
2317

2418
```javascript
2519
var pg = require('pg');
@@ -43,6 +37,8 @@ pg.connect(conString, function(err, client, done) {
4337

4438
```
4539

40+
[Check this out for the get up and running quickly example](https://github.com/brianc/node-postgres/wiki/Example)
41+
4642
### Simple
4743

4844
Sometimes you may not want to use a pool of connections. You can easily connect a single client to a postgres instance, run a query, and disconnect.
@@ -71,15 +67,11 @@ client.connect(function(err) {
7167

7268
```
7369

74-
## Documentation
75-
76-
Documentation is a work in progress primarily taking place on the github WIKI
77-
78-
### [Documentation](https://github.com/brianc/node-postgres/wiki)
70+
## [Documentation](https://github.com/brianc/node-postgres/wiki)
7971

8072
## Native Bindings
8173

82-
node-postgres contains a pure JavaScript driver and also exposes JavaScript bindings to libpq. You can use either interface. I personally use the JavaScript bindings as they are quite fast, and I like having everything implemented in JavaScript.
74+
node-postgres contains a pure JavaScript driver and also exposes JavaScript bindings via libpq. You can use either interface. I personally use the JavaScript bindings as they are quite fast, and I like having everything implemented in JavaScript.
8375

8476
To use native libpq bindings replace `require('pg')` with `require('pg').native`. If you __do not__ need or want the native bindings at all, consider using [node-postgres-pure](https://github.com/brianc/node-postgres-pure) instead which does not include them.
8577

@@ -103,7 +95,7 @@ __I love contributions.__
10395
You are welcome contribute via pull requests. If you need help getting the tests running locally feel free to email me or gchat me.
10496

10597
I will __happily__ accept your pull request if it:
106-
- _has tests_
98+
- _)has tests__
10799
- looks reasonable
108100
- does not break backwards compatibility
109101
- satisfies jshint
@@ -132,6 +124,7 @@ Follow me [@briancarlson](https://twitter.com/briancarlson) to keep up to date.
132124

133125
node-postgres is by design _low level_ with the bare minimum of abstraction. These might help out:
134126

127+
- [brianc/node-pg-native](https://github.com/brianc/node-pg-native) - Simple interface abstraction on top of [libpq](https://github.com/brianc/node-libpq)
135128
- [brianc/node-pg-query-stream](https://github.com/brianc/node-pg-query-stream) - Query results from node-postgres as a readable (object) stream
136129
- [brianc/node-pg-cursor](https://github.com/brianc/node-pg-cursor) - Query cursor extension for node-postgres
137130
- [brianc/node-pg-copy-streams](https://github.com/brianc/node-pg-copy-streams) - COPY FROM / COPY TO for node-postgres. Stream from one database to another, and stuff.
@@ -144,17 +137,12 @@ node-postgres is by design _low level_ with the bare minimum of abstraction. Th
144137
- [CSNW/sql-bricks](https://github.com/CSNW/sql-bricks) - Transparent, Schemaless SQL Generation
145138

146139

147-
## Production Use
148-
* [yammer.com](http://www.yammer.com)
149-
* [bayt.com](http://bayt.com)
150-
* [Vendly](http://www.vend.ly)
151-
* [SaferAging](http://www.saferaging.com)
152-
* [CartoDB](http://www.cartodb.com)
153-
* [Heap](https://heapanalytics.com)
154-
* [zoomsquare](http://www.zoomsquare.com/)
155-
* [WhenToManage](http://www.whentomanage.com)
156-
157-
_If you use node-postgres in production and would like your site listed here, fork & add it._
140+
### Windows
141+
142+
1. Install Visual Studio C++ (successfully built with Express 2010). Express is free.
143+
2. Add your Postgre Installation's `bin` folder to the system path (i.e. `C:\Program Files\PostgreSQL\9.3\bin`).
144+
3. Make sure that both `libpq.dll` and `pg_config.exe` are in that folder.
145+
4. `npm install pg`
158146

159147

160148
## License

0 commit comments

Comments
 (0)