Skip to content

Commit ab3b31b

Browse files
docs: Update Blockstore and Datastore implementation lists (#224)
* docs(interface-blockstore): add implementations to readme * docs(interface-datastore): alphabetize and update implementation links in readme * docs(interface-datastore): add IndexedDB to readme --------- Co-authored-by: Ronald M Zielaznicki <[email protected]> Co-authored-by: Alex Potsides <[email protected]>
1 parent cdc3f04 commit ab3b31b

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

packages/interface-blockstore/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
## Table of contents <!-- omit in toc -->
1111

1212
- [Install](#install)
13+
- [Implementations](#implementations)
1314
- [API Docs](#api-docs)
1415
- [License](#license)
1516
- [Contribute](#contribute)
@@ -20,6 +21,14 @@
2021
$ npm i interface-blockstore
2122
```
2223

24+
## Implementations
25+
26+
- File System: [`blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
27+
- IndexedDB: [`blockstore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-idb)
28+
- level: [`blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level) (supports any levelup compatible backend)
29+
- Memory: [`blockstore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/src/memory.ts)
30+
- S3: [`blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)
31+
2332
## API Docs
2433

2534
- <https://ipfs.github.io/js-stores/modules/interface_blockstore.html>

packages/interface-datastore/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,17 @@ Loading this module through a script tag will make it's exports available as `In
3838
## Implementations
3939

4040
- Backed Implementations
41-
- Memory: [`datastore-core/memory`](https://github.com/ipfs/js-datastore-core/tree/master/src/memory.js)
42-
- level: [`datastore-level`](https://github.com/ipfs/js-datastore-level) (supports any levelup compatible backend)
43-
- File System: [`datstore-fs`](https://github.com/ipfs/js-datastore-fs)
44-
- S3: [`datstore-s3`](https://github.com/ipfs/js-datastore-s3)
41+
- File System: [`datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
42+
- IndexedDB: [`datastore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-idb)
43+
- level: [`datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level) (supports any levelup compatible backend)
44+
- Memory: [`datastore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/memory.ts)
45+
- S3: [`datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
4546
- Wrapper Implementations
46-
- Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-datastore-core/tree/master/src/mount.js)
47-
- Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-datastore-core/tree/master/src/keytransform.js)
48-
- Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-datastore-core/tree/master/src/sharding.js)
49-
- Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-datastore-core/blob/master/src/tiered.js)
50-
- Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-datastore-core/tree/master/src/namespace.js)
47+
- Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/keytransform.ts)
48+
- Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/mount.ts)
49+
- Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/namespace.ts)
50+
- Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/sharding.ts)
51+
- Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/tiered.ts)
5152

5253
If you want the same functionality as [go-ds-flatfs](https://github.com/ipfs/go-ds-flatfs), use sharding with fs.
5354

0 commit comments

Comments
 (0)