Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fixed some markdown that github was causing issues on npmjs.org
  • Loading branch information
ben-page committed Jun 24, 2015
1 parent cb48e70 commit eb64ff6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A connection pool for [tedious](http://github.com/pekim/tedious).

npm install tedious-connection-pool

##Description
## Description
The only difference from the regular tedious API is how the connection is obtained and released. Rather than creating a connection and then closing it when finished, acquire a connection from the pool and release it when finished. Releasing resets the connection and makes in available for another use.

Once the Tedious Connection object has been acquired, the tedious API can be used with the connection as normal.
Expand Down Expand Up @@ -65,7 +65,7 @@ pool.drain();
```


##Class: ConnectionPool
## Class: ConnectionPool

### new ConnectionPool(poolConfig, connectionConfig)

Expand Down Expand Up @@ -94,7 +94,7 @@ Close all pooled connections and stop making new ones. The pool should be discar
### connectionPool.error {event}
The 'error' event is emitted when a connection fails to connect to the SQL Server.

##Class: Connection
## Class: Connection
The following method is added to the Tedious [Connection](http://pekim.github.com/tedious/api-connection.html) object.

### Connection.release()
Expand Down Expand Up @@ -132,4 +132,4 @@ Release the connect back to the pool to be used again
## Version 0.2.x Breaking Changes
* To acquire a connection, call on `acquire()` on a `ConnectionPool` rather than `requestConnection()`.
* After acquiring a `PooledConnection`, do not wait for the `'connected'` event. The connection is received connected.
* Call `release()` on a `PooledConnection` to release the it back to the pool. `close()` permanently closes the connection (as `close()` behaves in in tedious).
* Call `release()` on a `PooledConnection` to release the it back to the pool. `close()` permanently closes the connection (as `close()` behaves in in tedious).

0 comments on commit eb64ff6

Please sign in to comment.