Skip to content

Commit

Permalink
Merge branch 'master' of github.com:pouchdb/geopouch
Browse files Browse the repository at this point in the history
  • Loading branch information
calvinmetcalf committed Feb 8, 2016
2 parents aadd6a5 + 09af36f commit fe51f87
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Spatial Pouch [![Build Status](https://travis-ci.org/pouchdb/geopouch.svg?branch

Spatial plugin from PouchDB extracted and supporting N dimensional coordinates.

Originally by [@vmx](https://github.com/) with contribution by [@daleharvey](https://github.com/) and [@calvinmetcalf](https://github.com/).
Originally by [@vmx](https://github.com/vmx) with contribution by [@daleharvey](https://github.com/daleharvey) and [@calvinmetcalf](https://github.com/calvinmetcalf).

Test with `npm test` coverage report with `npm test --coverage`, build with `npm run build`.

Expand All @@ -18,11 +18,9 @@ API

`db.spatial('ddoc/functionName', [[xmin, ymin], [xmax, ymax]], options, callback);`

`db.spatial('ddoc/functionName', [[xmin, ymin, zmin], [xmax, ymax, zmin]], options, callback);`
`db.spatial('ddoc/functionName', [[xmin, ymin, zmin], [xmax, ymax, zmax]], options, callback);`

`db.spatial('ddoc/functionName', [xmin, ymin, zmin], [xmax, ymax, zmin], options, callback);`

`db.spatial('ddoc/functionName', [[xmin, ymin, zmin], [xmax, ymax, zmin]], options, callback);`
`db.spatial('ddoc/functionName', [xmin, ymin, zmin], [xmax, ymax, zmax], options, callback);`

`db.spatial('ddoc/functionName', [xmin, ymin, xmax, ymax], options).then(function (result) {}, function (err) {});`

Expand All @@ -34,4 +32,4 @@ you may either give a function or a path to a ddoc, bounding boxes may be given

If the callback is omited then a promise is returned.

Options are optional and valid options are include_docs and stale
Options are optional and valid options are include_docs and stale

0 comments on commit fe51f87

Please sign in to comment.