init project

README.md

@@ -1,2 +1,32 @@
-# timi-web-lib
+# timi-web-api
+
+Timi Web 的业务 API、领域类型、用户状态和权限相关能力。
+
+通用组件与工具位于 [timi-web](https://gitea.imyeyu.com/timi/timi-web)，本项目使用自己的 Axios 网络层，并依赖它提供 Cookie、Storage 等通用工具。
+
+## 依赖方向
+
+本项目是独立的业务能力包。只有需要业务 API、领域类型、用户状态或权限能力的项目才安装 `timi-web-api`；只使用通用组件的项目不需要安装本项目。
+
+```text
+只使用通用组件的业务项目 -> timi-tdesign-mobile / timi-tdesign-pc -> timi-web
+需要业务能力的业务项目 -> timi-web-api -> timi-web
+```
+
+`timi-tdesign-mobile` 和 `timi-tdesign-pc` 不依赖 `timi-web-api`。其中的文章、通知组件只约束 `Article`、`Attachment`、`NotifyDetail` 的最小字段，业务对象可以携带自定义字段，并通过上传和资源解析回调接入任意后端。
+
+## 目录
+
+- `src/api`：业务接口封装
+- `src/types`：业务领域类型
+- `src/store`：用户登录状态
+- `src/utils`：权限指令和配置映射
+- `src/editor`：文章、通知编辑器的数据适配
+
+## 检查
+
+```bash
+pnpm install
+pnpm run check
+```