@sanmokeji/smo-editor 0.0.2 → 0.0.3

package/README.md

@@ -1,48 +1,37 @@
-# smo-editor
+# @sanmokeji/smo-editor
 
-This template should help get you started developing with Vue 3 in Vite.
+🚀 **SmoEditor** 是一款基于 Vue 3 和 Tiptap 打造的轻量、高效、开箱即用的富文本编辑器组件。具备完美的 TypeScript 类型支持。
 
-## Recommended IDE Setup
+---
 
-[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
+## ✨ 特性
 
-## Recommended Browser Setup
+- ⚡ **轻量高效**：基于 Tiptap 核心精心封装，无冗余依赖。
+- 📦 **开箱即用**：内置常用富文本工具栏，集成图片上传、气泡菜单等高级功能。
+- 💙 **TypeScript 强类型**：提供完整的、模块化的类型定义，享受完美的 IDE 提示。
+- 🎨 **样式优雅**：原生支持现代样式体系，适配极佳。
 
-- Chromium-based browsers (Chrome, Edge, Brave, etc.):
-  - [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
-  - [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
-- Firefox:
-  - [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
-  - [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
+---
 
-## Type Support for `.vue` Imports in TS
+## 📦 安装
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+使用你喜欢的包管理器进行安装：
 
-## Customize configuration
+```bash
+# 使用 pnpm (推荐)
+pnpm add @sanmokeji/smo-editor
 
-See [Vite Configuration Reference](https://vite.dev/config/).
+# 使用 npm
+npm i @sanmokeji/smo-editor
 
-## Project Setup
-
-```sh
-pnpm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-pnpm dev
-```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
-pnpm build
+# 使用 yarn
+yarn add @sanmokeji/smo-editor
 ```
 
-### Lint with [ESLint](https://eslint.org/)
+## 开始使用
 
-```sh
-pnpm lint
+```ts
+import { SmoEditor, type SmoEditorOptions } from '@sanmokeji/smo-editor'
+// 2. 引入组件配套样式
+import '@sanmokeji/smo-editor/dist/index.css'
 ```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@sanmokeji/smo-editor",
-  "version": "0.0.2",
-  "main": "./dist/smo-editor.js",
-  "module": "./dist/smo-editor.js",
+  "version": "0.0.3",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",
   "exports": {
@@ -11,7 +11,7 @@
       "import": "./dist/smo-editor.js",
       "default": "./dist/smo-editor.js"
     },
-    "./dist/smo-editor.css": "./dist/smo-editor.css"
+    "./dist/index.css": "./dist/index.css"
   },
   "description": "基于 Tiptap + Vue 3 的富文本编辑器组件。",
   "keywords": [