docs: 新增文档，测试工作流的可行性吧

Author: juwenzhang

.changeset/config.json

@@ -2,9 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
   "changelog": "@changesets/cli/changelog",
   "commit": false,
-  "fixed": [
-    
-  ],
+  "fixed": [],
   "linked": [],
   "access": "restricted",
   "baseBranch": "main",

.github/workflows/auto-publish.yml

@@ -0,0 +1,66 @@
+name: Auto Publish Packages
+
+on:
+  push:
+    branches: [main, master]
+  
+  paths-ignore:
+    - '**/*.md'
+    - '**/*.yml'
+    - '.github/**'
+    - '**/*.txt'
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          registry-url: ${{ secrets.PUBLISH_URL }}
+          cache: 'pnpm'
+        
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8.x
+        
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      
+      - name: Build packages
+        run: pnpm build
+        continue-on-error: false
+      
+      - name: Configure Git User
+        run: | 
+          git config --global user.name "${{ secrets.GIT_NAME }}"
+          git config --global user.email "${{ secrets.GIT_EMAIL }}"
+      
+      - name: Bump versions with changeset
+        run: pnpm changeset version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to npm
+        run: pnpm changeset publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_CONFIG_REGISTRY: ${{ secrets.PUBLISH_URL }}
+      
+      - name: Push git tags
+        run: git push origin --tags
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      

README.md

@@ -0,0 +1,23 @@
+* 核心包：
+
+  * `@lyric-render/core`：内部包含了一些歌词解析的工具，例如：parser，cache 等通用的工具，以及一些类型的定义和常用 utils 吧
+
+  * `@lyric-render/react`：基于 core 包实现 react 的 hooks 和 components 吧
+
+  * `@lyric-render/vue`：基于 core 包实现 vue 的 components ，但是 vue 这里只是简单的实现
+
+* 技术栈使用
+
+    * 打包工具：rollup，typescript，vite(核心解决的是 vue 的打包的问题)
+
+    * UI渲染层框架使用：react 和 vue
+
+    * 语言：typescript
+
+* 后期功能升级计划
+
+    * [x] 去除 React 使用的CSS方案，选择一个更加适配的方案来替代 styled-components，打包后存在资源过大的问题
+
+    * [x] 组件适配 SSR 和 SSG 常见下渲染
+
+    * [x] 新增其他可扩展的功能，以及一些缓存优化，目前未实现开启 indexedDB 缓存功能

docs/CICD.md

@@ -0,0 +1,9 @@
+* 利用 changeset 来管理版本号以及 monorepo包的发布
+
+* 也是可以使用其他工具来管理版本号以及 monorepo包的发布，比如：
+  * `lerna`
+  * `nx`
+
+* 本仓库使用的方案是：pnpm + pnpm-workspace + changeset 来进行的哈
+
+> https://juejin.cn/post/7181720787400228925

packages/core/README.md

@@ -0,0 +1 @@
+# @lyric-render/core

packages/react/README.md

@@ -0,0 +1 @@
+# @lyric-render/react

packages/vue/README.md

@@ -0,0 +1 @@
+# @lyric-render/vue