cartodb/node-postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Brian Carlson 2010-12-14 19:37:09 -06:00
parent 26b28a7565
commit 87deb16611
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -3,17 +3,15 @@
Non-blocking (async) pure JavaScript PostgreSQL client for node.js written Non-blocking (async) pure JavaScript PostgreSQL client for node.js written
with love and TDD. with love and TDD.
## alpha version ## Installation
### Installation
npm install pg npm install pg
### Example ## Example
var pg = require('pg'); var pg = require('pg');
var connectionString = "pg://user:password@host:port/database";
pg.connect("pg://user:password@host:port/database", function(err, client) { pg.connect(connectionString, function(err, client) {
if(err) { if(err) {
//handle connection error //handle connection error
} }
@ -40,14 +38,14 @@ with love and TDD.
} }
} }
### Philosophy ## Philosophy
* well tested * well tested
* no monkey patching * no monkey patching
* no dependencies (...besides PostgreSQL) * no dependencies (...besides PostgreSQL)
* [in-depth documentation](http://github.com/brianc/node-postgres/wiki) (work in progress) * [in-depth documentation](http://github.com/brianc/node-postgres/wiki) (work in progress)
### features ## features
- prepared statement support - prepared statement support
- parameters - parameters
@ -60,7 +58,7 @@ with love and TDD.
- notification message support - notification message support
- connection pooling - connection pooling
- mucho testing - mucho testing
~1000 assertions executed on ~250 tests executed on
- ubuntu - ubuntu
- node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1 - node v0.2.2, v0.2.3, v0.2.4, v0.2.5, v0.3.0, v0.3.1
- postgres 8.4.4 - 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 - 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 - postgres v8.4.4, v9.0.1 installed both locally and on networked Windows 7
### Contributing ## Contributing
clone the repo: clone the repo:
git clone git://github.com/brianc/node-postgres git clone git://github.com/brianc/node-postgres
cd node-postgres cd node-postgres
node test/run.js make test
And just like magic, you're ready to contribute! <3 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? ### Why did you write this?
As soon as I saw node.js for the first time I knew I had found 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!
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). I drew major inspiration from [postgres-js](http://github.com/creationix/postgres-js).
@ -103,9 +99,7 @@ saw there.
### Plans for the future? ### Plans for the future?
- transparent prepared statement caching - transparent prepared statement caching
- connection pooling
- more testings of error scenarios - more testings of error scenarios
- streamline writing of buffers
## License ## License