Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
hackergrrl committed Feb 11, 2017
1 parent 245e4a4 commit 6f69d95
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,9 @@ Delete a document at `id`.

The options `opts` are passed to the underlying [hyperkv][4] instance.

A deletion tombstone may have a value associated with it. It will be set to the
value of `opts.value`, if set.

`cb(err, node)` fires with the underlying `node` in the hyperlog.

### osm.batch(rows, opts={}, cb)
Expand All @@ -204,7 +207,7 @@ Each `row` in `rows` should have:
* `row.type` - `'put'` or `'del'`
* `row.key` or `row.id` - the id of the document (generated if not specified)
* `row.links` - array of links to ancestor keys
* `row.value` - for puts, the value to store
* `row.value` - the value to store on a `put` or `del`

### osm.get(id, opts={}, cb)

Expand Down

0 comments on commit 6f69d95

Please sign in to comment.