From 5535440c55076921c1c980a2846623db8f5c4746 Mon Sep 17 00:00:00 2001
From: Himself65 <himself65@outlook.com>
Date: Tue, 11 Apr 2023 23:37:24 -0500
Subject: [PATCH] docs(y-indexeddb): add README.md (#1886)

---
 packages/y-indexeddb/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 packages/y-indexeddb/README.md

diff --git a/packages/y-indexeddb/README.md b/packages/y-indexeddb/README.md
new file mode 100644
index 0000000000..f8350381cb
--- /dev/null
+++ b/packages/y-indexeddb/README.md
@@ -0,0 +1,18 @@
+# @toeverything/y-indexeddb
+
+> This package haven't been published yet.
+
+## Usage
+
+```ts
+import { createIndexedDBProvider } from '@toeverything/y-indexeddb';
+import * as Y from 'yjs';
+const yDoc = new Y.Doc();
+
+const provider = createIndexedDBProvider('docName', yDoc);
+provider.connect();
+await provider.whenSynced.then(() => {
+  console.log('synced');
+  provider.disconnect();
+});
+```