diff --git a/README.md b/README.md index 7395c76..6325b96 100644 --- a/README.md +++ b/README.md @@ -62,33 +62,33 @@ Enter [`abstract-level`](https://github.com/Level/abstract-level). This module m ### How do I upgrade to `abstract-level`? -_This section is a work in progress that will explain how to replace old modules (that are based on `levelup` and `abstract-leveldown`) with new `abstract-level` based modules. At the time of writing, no `abstract-level` implementation has been published yet._ +_This section is a work in progress that will explain how to replace old modules (that are based on [`levelup`](https://github.com/Level/levelup) and [`abstract-leveldown`](https://github.com/Level/abstract-leveldown)) with new [`abstract-level`](https://github.com/Level/abstract-level) based modules. At the time of writing, no `abstract-level` implementation has been published yet._ -We've put together several upgrade guides for different modules. For example, if you're currently using `level@7` and no other modules (ignoring transitive dependencies of `level`) then it will suffice to read the upgrade guide of `level@8` (_not yet available_). +We've put together several upgrade guides for different modules. For example, if you're currently using `level@7` and no other modules (ignoring transitive dependencies) then it will suffice to read the upgrade guide of `level@8` (_not yet available_). -Naming-wise, databases generally use an npm package name in the form of `*-level` while utilities and plugins are called `level-*`. This replaces the [down versus up](https://github.com/Level/abstract-level/issues/6) naming scheme. Similarly, while it was previously helpful to distinguish between "database" and its "underlying store", now you will mostly just encounter the term "database" in documentation. +Naming-wise, databases generally use an npm package name in the form of `*-level` while utilities and plugins are called `level-*`. This replaces the [down versus up](https://github.com/Level/abstract-level/issues/6) naming scheme. Similarly, while it was previously helpful to distinguish between "database" and its "underlying store", now you will mostly just encounter the term "database" in our documentation. **If you are upgrading:** - + - + - + - + - + - + - + - + - + - From [`abstract-leveldown`](https://github.com/Level/abstract-leveldown) to `abstract-level`: see [`abstract-level@1`](https://github.com/Level/abstract-level/blob/main/UPGRADING.md#100) - From [`levelup`](https://github.com/Level/levelup): if the module that you're wrapping with `levelup` is listed here, then that, else see [`abstract-level@1`](https://github.com/Level/abstract-level/blob/main/UPGRADING.md#100) @@ -96,7 +96,7 @@ Naming-wise, databases generally use an npm package name in the form of `*-level -The following modules are or will be deprecated: `leveldown`, `memdown`, `level-mem`, `rocksdb`, `rocksdb-level`, `subleveldown`, `level-party`, `multileveldown`. The same goes for `levelup`, `deferred-leveldown`, `encoding-down` and [`level-packager`](https://github.com/Level/packager), which in addition have no replacements as their functionality was merged into `abstract-level`. +The following modules are or will be deprecated: [`leveldown`](https://github.com/Level/leveldown), [`memdown`](https://github.com/Level/memdown), [`level-mem`](https://github.com/Level/mem), [`level-js`](https://github.com/Level/level-js), [`rocksdb`](https://github.com/Level/rocksdb), [`level-rocksdb`](https://github.com/Level/level-rocksdb), [`subleveldown`](https://github.com/Level/subleveldown), [`multileveldown`](https://github.com/Level/multileveldown), [`level-party`](https://github.com/Level/party). The same goes for [`levelup`](https://github.com/Level/levelup), [`deferred-leveldown`](https://github.com/Level/deferred-leveldown), [`encoding-down`](https://github.com/Level/encoding-down) and [`level-packager`](https://github.com/Level/packager), which in addition have no replacements as their functionality was merged into `abstract-level`. Lastly, there are new and replaced utilities. Most folks don't need direct access to these modules except for the first: