bump version and update Readme

Author: mirceaalexandru

README.md

@@ -1,7 +1,10 @@
+![Seneca](http://senecajs.org/files/assets/seneca-logo.png)
+> A [Seneca.js][] data storage plugin
+
 seneca-postgresql-store
 =======================
 
-[![Build Status](https://travis-ci.org/nherment/seneca-postgresql-store.svg)](https://travis-ci.org/nherment/seneca-postgresql-store)
+[![Build Status](https://travis-ci.org/marianr/seneca-postgresql-store.svg)](https://travis-ci.org/marianr/seneca-postgresql-store)
 
 seneca-postgresql-store is a [PostgreSQL][postgresqlorg] database plugin for the [Seneca][seneca] MVP toolkit. The plugin is using the
 [node-postgres][nodepg] driver.
@@ -35,6 +38,38 @@ Usage:
 [seneca]: http://senecajs.org/
 [nodepg]: https://github.com/brianc/node-postgres
 
+## Usage
+You don't use this module directly. It provides an underlying data storage engine for the Seneca entity API:
+
+```js
+var entity = seneca.make$('typename')
+entity.someproperty = "something"
+entity.anotherproperty = 100
+
+entity.save$(function (err, entity) { ... })
+entity.load$({id: ...}, function (err, entity) { ... })
+entity.list$({property: ...}, function (err, entity) { ... })
+entity.remove$({id: ...}, function (err, entity) { ... })
+```
+
+### Query Support
+The standard Seneca query format is supported:
+
+- `.list$({f1:v1, f2:v2, ...})` implies pseudo-query `f1==v1 AND f2==v2, ...`.
+
+- `.list$({f1:v1, ...}, {sort$:{field1:1}})` means sort by f1, ascending.
+
+- `.list$({f1:v1, ...}, {sort$:{field1:-1}})` means sort by f1, descending.
+
+- `.list$({f1:v1, ...}, {limit$:10})` means only return 10 results.
+
+- `.list$({f1:v1, ...}, {skip$:5})` means skip the first 5.
+
+- `.list$({f1:v1,...}, {fields$:['fd1','f2']})` means only return the listed fields.
+
+Note: you can use `sort$`, `limit$`, `skip$` and `fields$` together.
+
+
 ## Limits
 
 By default queries are limited to 20 values. This can be bypassed by passing the `nolimit` option, which if set to true will not limit any queries.
@@ -44,3 +79,22 @@ By default queries are limited to 20 values. This can be bypassed by passing the
 To filter the fields returned from the `list` operation, pass a `fields$` array of column names to return. If no `fields$` are passed, all fields are returned (i.e. `select *` is used). e.g.
 
     query.fields$ = ['id', 'name']
+
+
+### Native Driver
+As with all seneca stores, you can access the native driver, in this case, the `pg`
+`connection` object using `entity.native$(function (err, connectionPool, release) {...})`.
+Please make sure that you release the connection after using it.
+
+```
+entity.native$( function (err, client, releaseConnection){
+  // ... you can use client
+  // ... then release connection
+  releaseConnection()
+} )
+```
+
+
+## Contributing
+We encourage participation. If you feel you can help in any way, be it with
+examples, extra testing, or new features please get in touch.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "seneca-postgresql-store",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Seneca data store plugin for PostgreSQL",
   "main": "lib/postgresql-store.js",
   "author": "Marian Radulescu",