Skip to content

Commit

Permalink
Improve README.
Browse files Browse the repository at this point in the history
  • Loading branch information
satazor committed Mar 26, 2016
1 parent 1006a69 commit 6dfea96
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ A fast and easy to ease CouchDB iterator for views and all documents.

## Usage

### .couchdbIterator(couchdbAddr, [view], iterator, [options])
### Concurrent row iteration

`couchdbIterator(couchdbAddr, [view], iterator, [options])`

Calls `iterator` for each row of the database referenced by `couchdbAddr`.
If a `view` is supplied, iterates only over that view's rows.
Expand Down Expand Up @@ -71,7 +73,9 @@ Available options:
All querying options have no default value, except for `limit` which is `500`. Also, `stale` is automatically set to `ok` after the first iteration to further improve performance.


### .couchdbIterator.bulk(couchdbAddr, [view], iterator, [options])
### Bulk iteration

`couchdbIterator.bulk(couchdbAddr, [view], iterator, [options])`

Calls `iterator` for a bulk of rows of the database referenced by `couchdbAddr`.
If a `view` is supplied, iterates only over that view's rows.
Expand Down

0 comments on commit 6dfea96

Please sign in to comment.