From 87deb1661108edead2022eeaa9adec434b7d5ff1 Mon Sep 17 00:00:00 2001 From: Brian Carlson Date: Tue, 14 Dec 2010 19:37:09 -0600 Subject: [PATCH] updated readme --- README.md | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e91c19d..21d7e8e 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,15 @@ Non-blocking (async) pure JavaScript PostgreSQL client for node.js written with love and TDD. -## alpha version - -### Installation +## Installation npm install pg -### Example +## Example var pg = require('pg'); - - pg.connect("pg://user:password@host:port/database", function(err, client) { + var connectionString = "pg://user:password@host:port/database"; + pg.connect(connectionString, function(err, client) { if(err) { //handle connection error } @@ -40,14 +38,14 @@ with love and TDD. } } -### Philosophy +## Philosophy * well tested * no monkey patching * no dependencies (...besides PostgreSQL) * [in-depth documentation](http://github.com/brianc/node-postgres/wiki) (work in progress) -### features +## features - prepared statement support - parameters @@ -60,7 +58,7 @@ with love and TDD. - notification message support - connection pooling - mucho testing - ~1000 assertions executed on + ~250 tests executed on - ubuntu - node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1 - postgres 8.4.4 @@ -68,13 +66,13 @@ with love and TDD. - node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1 - postgres v8.4.4, v9.0.1 installed both locally and on networked Windows 7 -### Contributing +## Contributing clone the repo: git clone git://github.com/brianc/node-postgres cd node-postgres - node test/run.js + make test And just like magic, you're ready to contribute! <3 @@ -90,9 +88,7 @@ __PLEASE__ check out the [WIKI](node-postgres/wiki). __MUCH__ more information ### Why did you write this? -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! +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! I drew major inspiration from [postgres-js](http://github.com/creationix/postgres-js). @@ -103,9 +99,7 @@ saw there. ### Plans for the future? - transparent prepared statement caching -- connection pooling - more testings of error scenarios -- streamline writing of buffers ## License