Skip to content
This repository
Browse code

update readme

  • Loading branch information...
commit 452fa668e6fe4a8dfa818430ac6c33226214b2a8 1 parent 7397abb
Brian C authored

Showing 1 changed file with 17 additions and 14 deletions. Show diff stats Hide diff stats

  1. 31  README.md
31  README.md
Source Rendered
@@ -8,14 +8,6 @@ Non-blocking PostgreSQL client for node.js.  Pure JavaScript and native libpq bi
8 8
 
9 9
 ## Examples
10 10
 
11  
-All examples will work with the pure javascript bindings (currently default) or the libpq native (c/c++) bindings (currently in beta)
12  
-
13  
-To use native libpq bindings replace `require('pg')` with `require('pg').native`.
14  
-
15  
-The two share the same interface so __no other code changes should be required__.  If you find yourself having to change code other than the require statement when switching from `pg` to `pg.native`, please report an issue.
16  
-
17  
-node-postgres supports both an 'event emitter' style API and a 'callback' style.  The callback style is more concise and generally preferred, but the evented API can come in handy.  They can be mixed and matched.  The only events which do __not__ fire when callbacks are supplied are the `error` events, as they are to be handled by the callback function.
18  
-
19 11
 ### Simple, using built-in client pool
20 12
 
21 13
     var pg = require('pg'); 
@@ -73,9 +65,19 @@ node-postgres supports both an 'event emitter' style API and a 'callback' style.
73 65
       client.end();
74 66
     });
75 67
 
  68
+### Example notes
  69
+
  70
+node-postgres supports both an 'event emitter' style API and a 'callback' style.  The callback style is more concise and generally preferred, but the evented API can come in handy.  They can be mixed and matched.  The only events which do __not__ fire when callbacks are supplied are the `error` events, as they are to be handled by the callback function.
  71
+
  72
+All examples will work with the pure javascript bindings (currently default) or the libpq native (c/c++) bindings (currently in beta)
  73
+
  74
+To use native libpq bindings replace `require('pg')` with `require('pg').native`.
  75
+
  76
+The two share the same interface so __no other code changes should be required__.  If you find yourself having to change code other than the require statement when switching from `pg` to `pg.native`, please report an issue.
  77
+
76 78
 ### Info
77 79
 
78  
-* a pure javascript client and native libpq bindings with _the same api_
  80
+* pure javascript client and native libpq bindings share _the same api_
79 81
 * _heavily_ tested
80 82
   * the same suite of 200+ integration tests passed by both javascript & libpq bindings
81 83
   * benchmark & long-running memory leak tests performed before releases
@@ -84,7 +86,7 @@ node-postgres supports both an 'event emitter' style API and a 'callback' style.
84 86
     * Linux, OS X
85 87
     * node 2.x & 4.x
86 88
 * row-by-row result streaming
87  
-* optional, built-in connection pooling
  89
+* built-in (optional) connection pooling
88 90
 * responsive project maintainer
89 91
 * supported PostgreSQL features
90 92
   * parameterized queries
@@ -94,9 +96,7 @@ node-postgres supports both an 'event emitter' style API and a 'callback' style.
94 96
 * query queue
95 97
 * active development
96 98
 * fast
97  
-* No dependencies (other than PostgreSQL)
98  
-* No monkey patching
99  
-* Tried to mirror the node-mysql api as much as possible for future multi-database-supported ORM implementation ease
  99
+* close mirror of the node-mysql api for future multi-database-supported ORM implementation ease
100 100
 
101 101
 ### Contributors
102 102
 
@@ -110,15 +110,18 @@ Many thanks to the following:
110 110
 * [ef4](https://github.com/ef4)
111 111
 * [napa3um](https://github.com/napa3um)
112 112
 * [drdaeman](https://github.com/drdaeman)
  113
+* [booo](https://github.com/booo)
113 114
 
114 115
 ## Documentation
115 116
 
116  
-Still a work in progress, I am trying to flesh out the wiki...
  117
+Documentation is a work in progress primarily taking place on the github WIKI
117 118
 
118 119
 ### [Documentation](https://github.com/brianc/node-postgres/wiki)
119 120
 
120 121
 ### __PLEASE__ check out the WIKI
121 122
 
  123
+If you have a question, post it to the FAQ section of the WIKI so everyone can read the answer
  124
+
122 125
 ## Production Use
123 126
 * [bayt.com](http://bayt.com)
124 127
 

0 notes on commit 452fa66

Please sign in to comment.
Something went wrong with that request. Please try again.