@zeldafox/vue-tailwind-theme-kit 1.0.0 → 1.1.0

package/README.md

@@ -4,7 +4,7 @@
 
 ## 特性
 
-* 🎨 **动态全套主题切换**：内置包含 `theme`（默认样式）、`claude`、`twitter` 和 `vercel` 四套精美预设。
+* 🎨 **动态全套主题切换**：内置包含 `theme`（默认样式）、`claude`、`twitter`、`vercel` 以及包括 `amber_minimal`、`catppuccin`、`cyberpunk` 等在内的 40+ 套精美预设。
 * 🌓 **全属性映射**：通过 Tailwind CSS 预设自动扩展 `colors`（如 `background`、`foreground`、`primary`、`secondary`、`card`、`sidebar`、`muted` 等）、`borderRadius`、`fontFamily` 变量。
 * 🌓 **暗色模式切换**：支持手动切换、显式设置以及自动跟随系统偏好（`prefers-color-scheme`）。
 * ⚡ **SSR 安全设计**：使用 Vue `provide` / `inject` 进行应用级状态隔离，完全规避多请求下的跨请求状态污染，对 Nuxt 3 友好。
@@ -16,6 +16,8 @@
 ## 安装
 
 ```bash
+pnpm add @zeldafox/vue-tailwind-theme-kit
+# 或
 npm install @zeldafox/vue-tailwind-theme-kit
 ```
 
@@ -54,7 +56,7 @@ import './assets/main.css';
 const app = createApp(App);
 
 app.use(themePlugin, {
-  defaultTheme: 'theme', // 默认内置主题，可选 'theme' | 'claude' | 'twitter' | 'vercel'
+  defaultTheme: 'theme', // 默认内置主题，支持 theme、claude、twitter、vercel 等 40+ 种内置主题
   // defaultDark: false, // 是否默认启用暗色模式。若不填则自动感应系统深浅色偏好
 });
 
@@ -218,20 +220,65 @@ app.use(themePlugin, {
 
 ---
 
-## 开发与构建
+## 开发、构建与发布
+
+### 1. 本地开发与构建
 
 1. 安装依赖：
    ```bash
-   npm install
+   pnpm install
+   ```
+2. 运行本地开发与预览服务器：
+   ```bash
+   pnpm dev
    ```
-2. 执行编译：
+3. 执行编译：
    ```bash
-   npm run build
+   pnpm build
    ```
    该指令将使用 Vite 打包并将包编译生成到 `dist/` 文件夹下，包含 `index.es.js`, `index.umd.js` 以及 TypeScript 定义文件 `index.d.ts`。
 
 ---
 
+### 2. 发布到 NPM
+
+#### 方案 A：普通账户密码/OTP 验证发布
+
+1. **配置官方源**：确保本地使用的是 NPM 官方源（避免使用淘宝等镜像源）：
+   ```bash
+   npm config set registry https://registry.npmjs.org/
+   ```
+2. **登录 NPM 账号**：
+   ```bash
+   npm login
+   ```
+3. **发布公开 Scoped 包**：
+   ```bash
+   npm publish --access public
+   ```
+   *(如果账户配置了 2FA，终端会提示输入一次性验证码 OTP，或者可以通过 `--otp=xxxxxx` 参数直接传入验证码。)*
+
+#### 方案 B：使用安全密钥 (Security Key / 2FA) 的发布方案（推荐）
+
+如果你的账户开启了物理安全密钥（如 Touch ID、YubiKey 等 2FA 且无数字验证码），在终端直接发布可能会被拒绝。此时应通过 **颗粒度访问令牌 (Granular Access Token)** 来完成发布：
+
+1. **生成 Token**：
+   * 浏览器登录 [npmjs.com](https://www.npmjs.com/)，进入 **Access Tokens** -> **Generate New Token** -> **Granular Access Token**。
+   * 配置权限为 **Read and Write**，并选择适用于该包的作用域，接着勾选 **"Bypass two-factor authentication (2FA)"** 选项。
+   * 复制生成的 Token (形如 `npm_...`)。
+2. **本地配置与发布**：
+   * 在项目根目录下创建临时 `.npmrc` 文件：
+     ```text
+     //registry.npmjs.org/:_authToken=你的_NPM_TOKEN
+     ```
+   * 运行发布命令：
+     ```bash
+     npm publish --access public
+     ```
+   * **安全提示**：发布成功后，请立即**删除**根目录下的 `.npmrc` 文件以防 Token 泄露。
+
+---
+
 ## 授权许可
 
 [MIT License](LICENSE)