Skip to content

Commit 87deb16

Browse files
committed
updated readme
1 parent 26b28a7 commit 87deb16

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,15 @@
33
Non-blocking (async) pure JavaScript PostgreSQL client for node.js written
44
with love and TDD.
55

6-
## alpha version
7-
8-
### Installation
6+
## Installation
97

108
npm install pg
119

12-
### Example
10+
## Example
1311

1412
var pg = require('pg');
15-
16-
pg.connect("pg://user:password@host:port/database", function(err, client) {
13+
var connectionString = "pg://user:password@host:port/database";
14+
pg.connect(connectionString, function(err, client) {
1715
if(err) {
1816
//handle connection error
1917
}
@@ -40,14 +38,14 @@ with love and TDD.
4038
}
4139
}
4240

43-
### Philosophy
41+
## Philosophy
4442

4543
* well tested
4644
* no monkey patching
4745
* no dependencies (...besides PostgreSQL)
4846
* [in-depth documentation](http://github.com/brianc/node-postgres/wiki) (work in progress)
4947

50-
### features
48+
## features
5149

5250
- prepared statement support
5351
- parameters
@@ -60,21 +58,21 @@ with love and TDD.
6058
- notification message support
6159
- connection pooling
6260
- mucho testing
63-
~1000 assertions executed on
61+
~250 tests executed on
6462
- ubuntu
6563
- node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1
6664
- postgres 8.4.4
6765
- osx
6866
- node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1
6967
- postgres v8.4.4, v9.0.1 installed both locally and on networked Windows 7
7068

71-
### Contributing
69+
## Contributing
7270

7371
clone the repo:
7472

7573
git clone git://github.com/brianc/node-postgres
7674
cd node-postgres
77-
node test/run.js
75+
make test
7876

7977
And just like magic, you're ready to contribute! <3
8078

@@ -90,9 +88,7 @@ __PLEASE__ check out the [WIKI](node-postgres/wiki). __MUCH__ more information
9088

9189
### Why did you write this?
9290

93-
As soon as I saw node.js for the first time I knew I had found
94-
something lovely and simple and _just what I always wanted!_. So...I
95-
poked around for a while. I was excited. I still am!
91+
As soon as I saw node.js for the first time I knew I had found something lovely and simple and _just what I always wanted!_. So...I poked around for a while. I was excited. I still am!
9692

9793
I drew major inspiration from [postgres-js](http://github.com/creationix/postgres-js).
9894

@@ -103,9 +99,7 @@ saw there.
10399
### Plans for the future?
104100

105101
- transparent prepared statement caching
106-
- connection pooling
107102
- more testings of error scenarios
108-
- streamline writing of buffers
109103

110104
## License
111105

0 commit comments

Comments
 (0)