troncell-vue-component 1.0.0

package/README.md

@@ -0,0 +1,144 @@
+# Troncell Vue Component
+
+一个基于 Vue 3 的现代化 UI 组件库，包含多种精美的交互式组件。
+
+## 📦 安装
+
+```bash
+npm install troncell-vue-component
+# 或
+yarn add troncell-vue-component
+# 或
+pnpm add troncell-vue-component
+```
+
+## 🚀 使用
+
+### 完整引入
+
+```javascript
+import { createApp } from 'vue'
+import TroncellVueComponent from 'troncell-vue-component'
+import 'troncell-vue-component/dist/style.css' // 如果组件库包含样式文件
+
+const app = createApp(App)
+app.use(TroncellVueComponent)
+```
+
+### 按需引入
+
+```vue
+<template>
+  <div>
+    <Card3D 
+      title="标题"
+      content="内容描述"
+      :image-src="imageUrl"
+      :buttons="buttons"
+    />
+  </div>
+</template>
+
+<script setup>
+import { Card3D } from 'troncell-vue-component'
+
+const imageUrl = 'https://example.com/image.jpg'
+const buttons = [
+  { title: '了解更多', buttonType: 'a', url: 'https://example.com' },
+  { title: '立即开始', buttonType: 'button' }
+]
+</script>
+```
+
+## 📚 可用组件
+
+- **Card3D** - 3D 卡片组件
+- **AnimatedTestimonials** - 动画推荐组件
+- **Aurora** - 极光效果组件
+- **BendingGallery** - 弯曲画廊组件
+- **BentoGrid** - Bento 网格布局组件
+- **Carousel3D** - 3D 轮播组件
+- **ContainerScroll** - 容器滚动组件
+- **DirectionAwareHover** - 方向感知悬停组件
+- **Dock** - Dock 组件
+- **DomeGallery** - 圆顶画廊组件
+- **ExpandableGallery** - 可展开画廊组件
+- **FluidCursor** - 流体光标组件
+- **IButton** - 按钮组件
+- **IconCloud** - 图标云组件
+- **IInput** - 输入框组件
+- **InfiniteGrid** - 无限网格组件
+- **InfiniteMenu** - 无限菜单组件
+- **InspiraImageParticles** - 图像粒子组件
+- **InteractiveGridPattern** - 交互式网格图案组件
+- **Lightning** - 闪电效果组件
+- **LinkPreview** - 链接预览组件
+- **MagnifyingGlass** - 放大镜组件
+- **Marquee** - 跑马灯组件
+- **Meteors** - 流星效果组件
+- **PhotoGallery** - 照片画廊组件
+- **RegistrationForm** - 注册表单组件
+- **RippleButton** - 波纹按钮组件
+- **RollingGallery** - 滚动画廊组件
+- **ScratchToReveal** - 刮刮乐组件
+- **ScrollIsland** - 滚动岛屿组件
+- **SparkElement** - 火花元素组件
+- **SparklesText** - 闪烁文本组件
+- **Spline** - Spline 3D 组件
+- **Stack** - 堆叠组件
+- **TargetCursor** - 目标光标组件
+- **TestimonialSlider** - 推荐滑块组件
+- **Text3d** - 3D 文本组件
+- **TextGenerateEffect** - 文本生成效果组件
+- **Timeline** - 时间线组件
+- **TracingBeam** - 追踪光束组件
+- **Navigation** - 导航组件
+
+## 🛠️ 开发
+
+### 本地开发
+
+```bash
+npm run dev
+```
+
+### 构建组件库
+
+```bash
+npm run build:lib
+```
+
+构建产物将输出到 `dist` 目录：
+- `dist/index.mjs` - ES 模块格式
+- `dist/index.cjs` - CommonJS 格式
+- `dist/types/` - TypeScript 类型声明文件
+
+## 📝 发布到 npm
+
+1. 确保已登录 npm：
+```bash
+npm login
+```
+
+2. 更新版本号：
+```bash
+npm version patch  # 或 minor, major
+```
+
+3. 构建组件库：
+```bash
+npm run build:lib
+```
+
+4. 发布：
+```bash
+npm publish
+```
+
+## ⚙️ 依赖要求
+
+- Vue 3.5.0 或更高版本
+
+## 📄 许可证
+
+MIT