Skip to content

Commit

Permalink
fix: docs shouldn't require ready cores (#29)
Browse files Browse the repository at this point in the history
We no longer require cores to be ready as of
89ac7ae ([pull request #24][0]). This
updates the docs to reflect that.

[0]: #24
  • Loading branch information
EvanHahn authored Feb 22, 2024
1 parent 98a0e25 commit 7cd3aaf
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ const cores = [
new Hypercore('./core2'),
]
await Promise.all(cores.map(c => c.ready()))
const indexer = new MultiCoreIndex(cores, { storage: createStorage, batch })
```
Expand All @@ -75,7 +73,7 @@ Type: `Array<Hypercore>`

An array of [Hypercores](https://github.com/hypercore-protocol/hypercore-next)
to index. All Hypercores must share the same value encoding (`binary`, `utf-8`
or `json`). All Hypercores must have a `key` property that is populated, either by waiting for all of them to be ready or by instantiating them with the `key` opt.
or `json`).

### opts

Expand Down

0 comments on commit 7cd3aaf

Please sign in to comment.