feat: add usage

vincentdchan · Nov 25, 2023 · f15b7ba · f15b7ba
1 parent d0937c3
commit f15b7ba
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/blocky-example/app/readme.ts b/packages/blocky-example/app/readme.ts
@@ -1,5 +1,12 @@
 export const ReadMeContent = `
 <p>Blocky Editor is an editor which supports the concept of blocks. It can help you to build an editor like Notion. It's tiny, fast and extensible. You can extend it with blocks.</p>
+<h2>Usage</h2>
+<ul>
+  <li>Click on the text to input content</li>
+  <li>Type <code>\/</code> to trigger command panel</li>
+  <li>Type <code>@</code> to trigger mention panel</li>
+  <li>Drag the handle to re-order the blocks</li>
+</ul>
 <h2>Why?</h2>
 <p>
   The main goal of this project is to provide an editor which is small and fast enough to be embedded in Notion-like apps.