snapshot of https://github.com/toeverything/AFFiNE.git (canary, 2026-09-16; blobs > 131072B omitted)

packages/common/reader/README.md

@@ -0,0 +1,25 @@
+# Affine Blocksuite format YDoc reader
+
+## Usage
+
+### read rootYDoc
+
+```ts
+import { readAllDocsFromRootDoc } from '@affine/reader';
+
+const docs = readAllDocsFromRootDoc(rootDoc);
+console.log(Array.from(docsWithTrash.entries()));
+
+// [
+//   'doc-id-1', { title: 'test doc title' },
+//   // ...
+// ]
+```
+
+### read YDoc
+
+```ts
+import { readAllBlocksFromDoc } from '@affine/reader';
+
+const blocks = readAllBlocksFromDoc(doc);
+```