refactor timi-web

README.md

@@ -1,5 +1,34 @@
-# Vue 3 + TypeScript + Vite
+# timi-tdesign-mobile
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+Vue 3 移动端通用组件库，依赖 `timi-web` 提供基础组件和编辑器能力。
 
-Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
+本包不依赖 `timi-web-api`。业务项目可以只安装本包使用通用组件；需要业务接口、领域类型或用户状态时，再单独安装 `timi-web-api`。
+
+## 文章和通知组件
+
+`ArticleEditor`、`ArticleView`、`NotifyEditor`、`NotifyView` 只约束对象的最小字段。`Article`、`Attachment` 和 `NotifyDetail` 支持携带业务自定义字段，不要求对象来自 `timi-web-api`。
+
+上传和附件地址由业务项目通过回调注入：
+
+```vue
+<article-editor
+  :model-value="article"
+  :upload-image="uploadImage"
+  :upload-video="uploadVideo"
+  :resolve-attachment-url="resolveAttachmentUrl"
+  @update:model-value="article = $event"
+/>
+<article-view
+  :article="article"
+  :resolve-attachment-url="resolveAttachmentUrl"
+/>
+```
+
+通知组件使用同样的 `uploadImage`、`uploadVideo` 和 `resolveAttachmentUrl` 回调。没有附件上传需求时，可以不传上传回调。
+
+## 开发
+
+```bash
+pnpm install
+pnpm run build
+```