pro-comp-x 0.0.1 → 0.0.2

package/README.md

@@ -1,23 +1,68 @@
-# pro-components
+# Pro Comp X
 
-[![NPM version](https://img.shields.io/npm/v/pro-components.svg?style=flat)](https://npmjs.com/package/pro-components)
-[![NPM downloads](http://img.shields.io/npm/dm/pro-components.svg?style=flat)](https://npmjs.com/package/pro-components)
+无限可能的组件库 - 独立版本
 
-## Install
+## 特性
+
+- 🎯 **独立打包**: 不依赖外部antd安装，antd4组件已内置
+- 📦 **按需引入**: 只打包实际使用的antd组件
+- 🎨 **样式完整**: 包含所有必要的CSS样式
+- ⚡ **零配置**: 开箱即用，无需额外配置
+
+## 安装
 
 ```bash
-$ yarn install
+npm install pro-comp-x
+# 或
+yarn add pro-comp-x
+# 或
+pnpm add pro-comp-x
 ```
 
-```bash
-$ npm run dev
-$ npm run build
+## 使用
+
+### 基础使用
+
+```tsx
+import React from 'react';
+import { Panel, PageList, RenderForm } from 'pro-comp-x';
+// 引入样式文件
+import 'pro-comp-x/dist/index.css';
+
+function App() {
+  return (
+    <div>
+      <Panel title="示例面板">
+        <PageList />
+      </Panel>
+    </div>
+  );
+}
 ```
 
-## Options
+### 按需引入
+
+```tsx
+import Panel from 'pro-comp-x/dist/esm/components/Panel';
+import PageList from 'pro-comp-x/dist/esm/components/PageList';
+import 'pro-comp-x/dist/index.css';
+```
+
+## 组件列表
+
+- `Panel` - 面板组件
+- `PageList` - 分页列表组件  
+- `PageWraper` - 页面容器
+- `RenderForm` - 表单渲染器
+- `DraggableTable` - 可拖拽表格
+- `Modal`、`DatePicker`、`Upload` 等扩展组件
+
+## 兼容性
 
-TODO
+- React >= 16.8.0
+- 不依赖antd安装（已内置antd4组件）
+- 支持TypeScript
 
-## LICENSE
+## 版本说明
 
-MIT
+此版本已将antd4组件直接编译到包中，业务系统无需安装antd即可使用。