Skip to content

Commit

Permalink
readme: link to upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphtheninja committed Jan 24, 2018
1 parent 0d942fd commit ef61b68
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -16,6 +16,8 @@ You add functionality by implementing the underscore versions of the operations.

Additionally, all methods provide argument checking and sensible defaults for optional arguments. All bad-argument errors are compatible with `leveldown` (they pass the `leveldown` method arguments tests). For example, if you call `.open()` without a callback argument you'll get an `Error('open() requires a callback argument')`. Where optional arguments are involved, your underscore methods will receive sensible defaults. A `.get(key, callback)` will pass through to a `._get(key, options, callback)` where the `options` argument is an empty object.

**If you are upgrading:** please see [UPGRADING.md](UPGRADING.md).

## Example

A simplistic in-memory `leveldown` replacement
Expand Down

0 comments on commit ef61b68

Please sign in to comment.