Skip to content

Commit

Permalink
docs: Update Blockstore and Datastore implementation lists (#224)
Browse files Browse the repository at this point in the history
* 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 <git_6hiw@ronald.m.zielaznicki.com>
Co-authored-by: Alex Potsides <alex@achingbrain.net>
  • Loading branch information
3 people committed Jun 3, 2023
1 parent cdc3f04 commit ab3b31b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
9 changes: 9 additions & 0 deletions packages/interface-blockstore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
## Table of contents <!-- omit in toc -->

- [Install](#install)
- [Implementations](#implementations)
- [API Docs](#api-docs)
- [License](#license)
- [Contribute](#contribute)
Expand All @@ -20,6 +21,14 @@
$ npm i interface-blockstore
```

## Implementations

- File System: [`blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
- IndexedDB: [`blockstore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-idb)
- level: [`blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level) (supports any levelup compatible backend)
- Memory: [`blockstore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/src/memory.ts)
- S3: [`blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)

## API Docs

- <https://ipfs.github.io/js-stores/modules/interface_blockstore.html>
Expand Down
19 changes: 10 additions & 9 deletions packages/interface-datastore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,17 @@ Loading this module through a script tag will make it's exports available as `In
## Implementations

- Backed Implementations
- Memory: [`datastore-core/memory`](https://github.com/ipfs/js-datastore-core/tree/master/src/memory.js)
- level: [`datastore-level`](https://github.com/ipfs/js-datastore-level) (supports any levelup compatible backend)
- File System: [`datstore-fs`](https://github.com/ipfs/js-datastore-fs)
- S3: [`datstore-s3`](https://github.com/ipfs/js-datastore-s3)
- File System: [`datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
- IndexedDB: [`datastore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-idb)
- level: [`datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level) (supports any levelup compatible backend)
- Memory: [`datastore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/memory.ts)
- S3: [`datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
- Wrapper Implementations
- Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-datastore-core/tree/master/src/mount.js)
- Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-datastore-core/tree/master/src/keytransform.js)
- Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-datastore-core/tree/master/src/sharding.js)
- Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-datastore-core/blob/master/src/tiered.js)
- Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-datastore-core/tree/master/src/namespace.js)
- Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/keytransform.ts)
- Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/mount.ts)
- Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/namespace.ts)
- Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/sharding.ts)
- Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/tiered.ts)

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

Expand Down

0 comments on commit ab3b31b

Please sign in to comment.