@breezeui/vue 0.0.1

package/README.md

@@ -0,0 +1,115 @@
+# BreezeUI
+
+<p align="center">
+  <img src="https://via.placeholder.com/200x200.png?text=BreezeUI+Logo" alt="BreezeUI Logo" width="200"/>
+</p>
+
+<p align="center">
+  轻量、可定制、基于 TailwindCSS 的 Vue 3 组件库
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@breezeui/vue">
+    <img src="https://img.shields.io/npm/v/@breezeui/vue.svg" alt="npm version">
+  </a>
+  <a href="https://github.com/breezeui-vue/breezeui/blob/main/LICENSE">
+    <img src="https://img.shields.io/npm/l/@breezeui/vue.svg" alt="license">
+  </a>
+</p>
+
+## ✨ 特性
+
+- ⚡️ **轻量级**: 专为性能打造，体积小巧。
+- 🎨 **TailwindCSS**: 基于 TailwindCSS 构建，完全可定制。
+- 🔧 **TypeScript**: 全量 TypeScript 编写，提供优秀的类型推导。
+- 🧩 **Vue 3**: 拥抱 Vue 3 Composition API。
+- 🌲 **按需引入**: 支持 Tree Shaking，只打包你用到的代码。
+
+## 📦 安装
+
+推荐使用 `pnpm` 进行安装：
+
+```bash
+pnpm add @breezeui/vue
+```
+
+或者使用 yarn / npm：
+
+```bash
+yarn add @breezeui/vue
+# or
+npm install @breezeui/vue
+```
+
+## 🚀 快速上手
+
+### 全局引入
+
+在你的 `main.ts` 或 `main.js` 入口文件中：
+
+```ts
+import { createApp } from 'vue';
+import App from './App.vue';
+import BreezeUI from '@breezeui/vue';
+import '@breezeui/vue/dist/index.css'; // 引入样式
+
+const app = createApp(App);
+app.use(BreezeUI);
+app.mount('#app');
+```
+
+### 按需引入 (推荐)
+
+配合 `unplugin-vue-components` 实现自动按需引入。
+
+首先安装插件：
+
+```bash
+pnpm add -D unplugin-vue-components
+```
+
+然后配置 `vite.config.ts`：
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import Components from 'unplugin-vue-components/vite';
+// 假设 BreezeUI 提供了 Resolver，如果没有，可以手动配置
+// import { BreezeUIResolver } from '@breezeui/vue'; 
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    Components({
+      // 如果 BreezeUI 提供了 Resolver
+      // resolvers: [BreezeUIResolver()],
+      
+      // 如果没有 Resolver，可以手动指定组件库目录或规则
+      // dirs: ['src/components'], 
+    }),
+  ],
+});
+```
+
+> 注意：按需引入时，如果组件库样式未自动注入，可能需要手动引入样式文件或配置插件处理样式。
+
+## 🔨 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 启动开发环境
+pnpm dev
+
+# 构建包
+pnpm build
+
+# 运行测试
+pnpm test
+```
+
+## 📄 License
+
+MIT License © 2024-PRESENT BreezeUI Team