From 0c96d0e937ac411c2d4dc8ddee0898a70f2decc2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=BC=A0=E4=BC=A0=E9=BE=99?= <zclzone@outlook.com>
Date: Mon, 11 Jul 2022 12:29:48 +0800
Subject: [PATCH] docs(readme): update readme

---
 README.md | 49 ++++++++++++++++++++++++-------------------------
 1 file changed, 24 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index c320640..9fc76c4 100644
--- a/README.md
+++ b/README.md
@@ -13,33 +13,28 @@
 
 ### 简介
 
-[Vue Naive Admin](https://github.com/zclzone/vue-naive-admin)是一个 **完全开源免费且允许商用** 的后台管理模板，基于 Vue3、Vite2、Pinia 和 Naive UI等前端最新技术栈。相较于其他比较流行的后台管理模板，此项目相对简洁、轻量，学习成本非常低。麻雀虽小，五脏俱全，权限、Mock、菜单、axios 封装、pinia、项目配置、样式配置、环境配置，以及一些经常用的基础组件封装等等这些该有的都有，非常适合中小型项目或者个人项目。
-
-### 为什么要开发这个模板
-
-- Vue3 和 Vite 已经趋于成熟，学习 vite 和 vue3 非常有必要，通过开发模板进行学习是一个很好的方式，事实也证明我确实从中获益良多
-- 目前主流的 Vue3+Vite 后台管理模板都相对复杂，甚至感觉有点花里胡哨（没有贬低的意思，大部分的架构设计都很优秀，只是觉得集成了太多不实用的东西）
+[Vue Naive Admin](https://github.com/zclzone/vue-naive-admin)是一个 **完全开源免费且允许商用** 的后台管理模板，基于 **Vue3、Vite2、Pinia、Unocss 和 Naive UI**等前端最新技术栈。相较于其他比较流行的后台管理模板，此项目更加简洁、轻量，风格清新，学习成本非常低，非常适合中小型项目或者个人项目。
 
 ### 功能
 
-- 🍒 集成 Naive UI，尤大推荐的 UI 组件库，[https://www.naiveui.com](https://www.naiveui.com)
+- 🍒 集成 [Naive UI](https://www.naiveui.com)，尤大推荐的 UI 组件库
 - 🍑 集成登陆、注销及权限验证
 - 🍐 集成多环境配置，dev、测试、生产和github pages环境
-- 🍎 集成 Eslint + Prettier，代码约束和格式化统一
-- 🍉 集成 Mock 接口服务，dev 环境和发布环境都支持，可动态配置是否启用 mock 服务，不启用时不会加载 mock 包，减少打包体积
-- 🍇 集成 unocss，antfu 大神开源的原子化 css 解决方案，非常轻量，目前我是自己写 scss 样式搭配着 unocss 使用的
-- 🍍 集成 Pinia，Vuex 的替代方案，轻量、简单、易用（尤大已表示不会有Vuex5，或者说pinia就是Vuex5）
-- 📦 集成 Vite 自动导入插件unplugin-vue-components，解放双手，开发效率直接起飞
-- 🤹 集成 unplugin-icons插件，优雅使用iconify图标
-- 🍏 二次封装 Axios，支持多 axios 实例
-- 🍌 二次封装全局 Dialog、Message、LoadingBar 组件
+- 🍎 集成 `eslint + prettier`，代码约束和格式化统一
+- 🍌 集成 `husky + commitlint`，代码提交规范化
+- 🍉 集成 `Mock` 接口服务，dev 环境和发布环境都支持，可动态配置是否启用 mock 服务，不启用时不会加载 mock 包，减少打包体积
+- 🍍 集成 `pinia`，vuex 的替代方案，轻量、简单、易用
+- 📦 集成 `unplugin` 插件，自动导入，解放双手，开发效率直接起飞
+- 🤹 集成 `iconify` 图标，支持自定义 svg 图标, 优雅使用icon
+- 🍇 集成 `unocss`，antfu 开源的原子 css 解决方案，非常轻量
+- 🍏 二次封装 Axios，支持`多 axios 实例`
 - 🍋 二次封装 localStorage 和 sessionStorage，支持设置过期时间
 
 ### 预览
 
 [template.qszone.com](https://template.qszone.com)
 
-[github pages](https://zclzone.github.io/vue-naive-admin)
+[zclzone.github.io/vue-naive-admin（github pages）](https://zclzone.github.io/vue-naive-admin)
 
 ### 文档
 
@@ -47,7 +42,7 @@
 
 [羽雀文档：Vue Naive Admin](https://www.yuque.com/qszone/vue-naive-admin)
 
-### 构建
+### 快速开始
 
 ```shell
 # 推荐配置git autocrlf 为 false（本项目规范使用lf换行符，此配置是为防止git自动将源文件转换为crlf）
@@ -61,36 +56,40 @@ git clone https://github.com/zclzone/vue-naive-admin.git
 cd vue-naive-admin
 
 # 安装依赖(建议使用pnpm: https://pnpm.io/zh/installation)
+npm i -g pnpm # 装了可忽略
 pnpm i # 或者 npm i
 
 # 启动
-npm run dev
+pnpm dev
 ```
 
-### 发布
+### 构建发布
 
 ```shell
 # 构建测试环境
-npm run build:test
+pnpm build:test
 
 # 构建github pages环境
-npm run build:github
+pnpm build:github
 
 # 构建生产环境
-npm run build
+pnpm build
 ```
 
 ### 其他指令
 
 ```shell
 # eslint代码格式检查
-npm run lint
+pnpm lint
 
 # 代码检查并修复
-npm run lint:fix
+pnpm lint:fix
 
 # 预览发布包效果（需先执行构建指令）
-npm run preview
+pnpm preview
+
+# 提交代码（husky+commitlint）
+pnpm cz
 ```
 
 ### 规范