@idooel/components 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,99 @@
+# @idooel/components
+
+基于Vue 2.x的组件库，提供了一系列可复用的UI组件和业务组件。
+
+## 特性
+
+- 基于Vue 2.x开发
+- 使用Ant Design Vue作为基础UI框架
+- 支持UMD和ESM两种模块格式
+- 提供丰富的业务组件
+- 支持主题定制
+- 支持国际化
+
+## 安装
+
+```bash
+npm install @idooel/components
+# 或
+yarn add @idooel/components
+# 或
+pnpm add @idooel/components
+```
+
+## 使用
+
+### 完整引入
+
+```javascript
+import Vue from 'vue'
+import Components from '@idooel/components'
+import 'ant-design-vue/dist/antd.css'
+
+Vue.use(Components)
+```
+
+### 按需引入
+
+```javascript
+import Vue from 'vue'
+import { Button, Input } from '@idooel/components'
+
+Vue.use(Button)
+Vue.use(Input)
+```
+
+## 组件列表
+
+### 基础组件
+- Button 按钮
+- Input 输入框
+- Select 选择器
+- DatePicker 日期选择器
+- Upload 上传组件
+- Editor 富文本编辑器
+
+### 业务组件
+- [待补充]
+
+## 依赖说明
+
+### 主要依赖
+- Vue 2.x
+- Ant Design Vue 1.7.8
+- @idooel/expression
+- @idooel/shared
+
+### 开发依赖
+- Rollup
+- Babel
+- PostCSS
+- Vue Template Compiler
+
+## 开发指南
+
+### 构建
+```bash
+# 构建UMD格式
+npm run build:umd
+
+# 构建ESM格式
+npm run build:esm
+```
+
+### 本地开发
+```bash
+# 待补充
+```
+
+## 贡献指南
+
+1. Fork 项目
+2. 创建特性分支
+3. 提交变更
+4. 推送到分支
+5. 创建 Pull Request
+
+## 许可证
+
+ISC