diff --git a/packages/mini-markdown-editor/README.md b/packages/mini-markdown-editor/README.md
index d996e486d28d2ff9c659992920fe8689a4c95df5..8f6eb1f525c6ada31d5e901189972ac3327d6f17 100644
--- a/packages/mini-markdown-editor/README.md
+++ b/packages/mini-markdown-editor/README.md
@@ -1,6 +1,26 @@
 # mini-markdown-editor
 
-## 脚本
+## 安装
+
+```bash
+pnpm install @mini-markdown-rc/editor
+```
+
+## 使用
+
+```tsx
+import { Editor } from "@mini-markdown-rc/editor";
+
+export default function App() {
+  return <Editor />;
+}
+```
+
+## API
+
+具体API参考 [https://github.com/xiaotianna/mini-markdown-editor/blob/master/docs/guide/api.md](https://github.com/xiaotianna/mini-markdown-editor/blob/master/docs/guide/api.md)
+
+## 开发脚本
 
 ```bash
 ## 开发环境运行