fix: docs shouldn't require ready cores

[EvanHahn]

We no longer require cores to be ready as of #24. This updates the docs to reflect that.

(Please let me know if I've misunderstood how things should work in this module!)

[achou11]

Yeah I think your assessment is correct! Maybe just to check, try running the tests without this line?

multi-core-indexer/test/helpers/index.js

Line 48 in 98a0e25

await core.ready()

[EvanHahn]

It worked after a small (test-only) patch:

diff --git a/test/helpers/index.js b/test/helpers/index.js
index 65f229f..fb3db58 100644
--- a/test/helpers/index.js
+++ b/test/helpers/index.js
@@ -45,7 +45,7 @@ function replicate(a, b, t) {
 async function create(...args) {
   /* @ts-ignore: TODO: better types for random access modules */
   const core = new Hypercore(ram, ...args)
-  await core.ready()
+  // await core.ready()
   return core
 }
 
diff --git a/test/unit-tests/core-index-stream.test.js b/test/unit-tests/core-index-stream.test.js
index 67ef9c4..121a0c4 100644
--- a/test/unit-tests/core-index-stream.test.js
+++ b/test/unit-tests/core-index-stream.test.js
@@ -32,6 +32,7 @@ test('destroy before open', async (t) => {
 
 test('Indexes all items already in a core', async (t) => {
   const a = await create()
+  await a.ready()
   const blocks = generateFixture(0, 10)
   const expected = blocksToExpected(blocks, a.key)
   await a.append(blocks)
@@ -55,6 +56,7 @@ test("Empty core emits 'drained' event", async (t) => {
 test('.remaining property is accurate', async (t) => {
   const totalBlocks = 100
   const a = await create()
+  await a.ready()
   const blocks = generateFixture(0, totalBlocks)
   const expected = blocksToExpected(blocks, a.key)
   await a.append(blocks)

(I believe this is fine...it happens because the tests assume the key has already been set when concocting expected.)