Skip to content

Commit

Permalink
adds warning in README.md about using level 1.x packages
Browse files Browse the repository at this point in the history
  • Loading branch information
jacoscaz committed Nov 14, 2024
1 parent 5423049 commit 6f3df9a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,14 @@ exceedingly high bundle sizes.
[AbstractLevel interface][db1]. An incomplete list of available backends
is available at [level/awesome#stores][db6].

<div style="padding: 1em; margin: 1em 0; background: #ffa0a2; color: #000;" markdown="1">
**Note that quadstore is only compatible with `abstract-level`'s API as of
its `1.x` versions. Packages whose semver major version number tracks that
of `abstract-level`, such as `classic-level` and `memory-level`, must be
used up to their most recent `1.x` version. The switch to `abstract-level`
version `2.x` is tracked in [#168][db11].**
</div>

Our test suite focuses on the following backends:

- [`classic-level`][db2] for persistent, on-disk storage using [LevelDB][db0]
Expand All @@ -201,6 +209,7 @@ Our test suite focuses on the following backends:
[db8]: https://github.com/level
[db9]: https://github.com/Level/browser-level
[db10]: https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API
[db11]: https://github.com/quadstorejs/quadstore/issues/168

### Data model and return values

Expand Down

0 comments on commit 6f3df9a

Please sign in to comment.