Skip to content

Commit eb1d9a7

Browse files
committed
chore: deprecate blockstore-level and datastore-fs
1 parent be0873c commit eb1d9a7

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

packages/blockstore-level/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# blockstore-level
22

3+
## ⚠️ Deprecation Warning
4+
5+
**This package is deprecated. Instead, use `blockstore-fs` in node.js, and `blockstore-idb` in browsers.**
6+
37
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
48
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
59
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
@@ -24,9 +28,9 @@ repo and examine the changes made.
2428
2529
-->
2630

27-
A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
31+
⚠️ This package is deprecated. Instead, use `blockstore-fs` in node.js, and `blockstore-idb` in browsers.
2832

29-
N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
33+
A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
3034

3135
## Example
3236

packages/blockstore-level/src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
/**
22
* @packageDocumentation
33
*
4-
* A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
4+
* ⚠️ This package is deprecated. Instead, use `blockstore-fs` in node.js, and `blockstore-idb` in browsers.
55
*
6-
* N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
6+
* A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
77
*
88
* @example
99
*

packages/datastore-fs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# datastore-fs
22

3+
## ⚠️ Deprecation Warning
4+
5+
**This package is deprecated. Instead, use `datastore-level` in node.js, and `datastore-idb` in browsers.**
6+
37
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
48
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
59
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
@@ -24,6 +28,8 @@ repo and examine the changes made.
2428
2529
-->
2630

31+
⚠️ This package is deprecated. Instead, use `datastore-level` in node.js, and `datastore-idb` in browsers.
32+
2733
A Datastore implementation with a file system backend.
2834

2935
## Example

packages/datastore-fs/src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
/**
22
* @packageDocumentation
33
*
4+
* ⚠️ This package is deprecated. Instead, use `datastore-level` in node.js, and `datastore-idb` in browsers.
5+
*
46
* A Datastore implementation with a file system backend.
57
*
68
* @example

0 commit comments

Comments
 (0)