From 01f6ad20ed4cea09950a1fa88fc1a213e1404b54 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=97=B6=E5=90=AF=E9=BE=99?= <shiqilong@beyondcent.com>
Date: Tue, 17 Dec 2024 15:06:18 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20README.md=EF=BC=8C?=
 =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E7=8E=AF=E5=A2=83=E5=87=86=E5=A4=87=E5=92=8C?=
 =?UTF-8?q?=E5=BF=AB=E9=80=9F=E5=BC=80=E5=A7=8B=E6=8C=87=E5=8D=97=EF=BC=8C?=
 =?UTF-8?q?=E4=BF=AE=E6=94=B9=E9=A1=B9=E7=9B=AE=E9=85=8D=E7=BD=AE=E8=AF=B4?=
 =?UTF-8?q?=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 36 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 828d94b..417cf30 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,45 @@
-# vue3.0-tpl
+# 博云 CMP Web 前端项目
 
-## Project setup
-```
-yarn install
+## 环境准备
+
+- Node.js 16+
+- pnpm ([安装指南](https://pnpm.io/installation))
+
+## 快速开始
+
+1. 配置私有 NPM 源
+
+```bash
+# 设置 registry
+npm config set registry http://58.210.154.140:13011/repository/bocloud-npm/
+npm config set _auth Ym9jbG91ZDpjbXBAdjU4Nw==
+
+# npm 相关配置
+npm config set auto-install-peers=true
+npm config set strict-peer-dependencies=false
+npm config set shamefully-hoist=true
+npm config set always-auth true
 ```
 
-### Compiles and hot-reloads for development
-```
-yarn serve
+2. 安装依赖
+
+```bash
+pnpm install
 ```
 
-### Compiles and minifies for production
-```
-yarn build
+3. 本地开发
+
+```bash
+pnpm run serve  # 推荐：使用 vue-cli-service
 ```
 
-### Lints and fixes files
-```
-yarn lint
+4. 项目构建
+
+```bash
+pnpm run build
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## 注意事项
+
+- 不推荐使用 vite 进行开发，存在兼容性问题
+- 建议使用 vue-cli-service serve 进行本地开发