From 5098e7744c781e649929b80691e60c4a33302b53 Mon Sep 17 00:00:00 2001
From: BoBoooooo <17746714@qq.com>
Date: Fri, 16 Oct 2020 17:12:14 +0800
Subject: [PATCH] docs: update ReadME

---
 README.md | 70 ++++++++++++++++++++++++++-----------------------------
 1 file changed, 33 insertions(+), 37 deletions(-)

diff --git a/README.md b/README.md
index 18e28b0..0ec1533 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,36 @@
 # BoBo's Vue Admin  
 
-( 🚀  9.19号 vue 3已经发布,正在尝试迁移中.)
+( 🚀  `9.19号 Vue3发布`, 本项目暂不考虑迁移)
 
 本项目基于 [Vue CLI 4.x](https://cli.vuejs.org/config/) 构建。
 
-🍌   在线演示地址 http://server.boboooooo.top:9999/
+🍌 [在线演示地址](http://server.boboooooo.top:9999/)
 
-🍉   项目文档 https://github.com/BoBoooooo/BoBo-Vue-Admin/wiki/CrudTable-%E6%96%87%E6%A1%A3 
+🍉   [项目文档](https://github.com/BoBoooooo/BoBo-Vue-Admin/wiki/CrudTable-%E6%96%87%E6%A1%A3/)
 
-🍏   配套后端地址 https://github.com/BoBoooooo/NestJS-API-Server.git (还在初期阶段)
+🍏   [配套后端地址](https://github.com/BoBoooooo/NestJS-API-Server.git) (初期阶段)
 
+## 1. 核心功能
 
-## 0、核心功能
+* **三员管理** `用户部门角色`
 
-* 基础三员管理(用户部门角色)
+* **字典管理**
 
-* 权限模块
+* **权限模块**
 
-* 表单设计器 (基于 (https://github.com/GavinZhuLei/vue-form-making) 开源版本代码进行二次开发重构,感谢大佬!如有侵权及时联系)
-  * 新增附件组件
-  * 文本组件
-  * 按钮组件
-  * 表格组件
-  * 级联选择器
-  * 富文本编辑器(Tinymce)
-* 表格设计器 (基于表单设计json自动生成列表json,可视化配置)
-* CrudTable组件 (结合表单表格设计器,传统单表crud一键完成开发,全靠配置,解放生产力)
+* **表单设计器** (基于[vue-form-making](https://github.com/GavinZhuLei/vue-form-making) 开源版本二次开发,感谢大佬!)
+  * 新增下列组件
+  * `附件组件 (FileUpload)`
+  * `文本组件 (h3)`
+  * `按钮组件 (el-button)`
+  * `表格组件 (CrudTable)`
+  * `级联选择器 (el-cascader)`
+  * `富文本编辑器 (Tinymce)`
+  * `树形下拉选择框 (tree-select)`
+* **表格设计器** `基于表单设计json自动生成列表json,可视化配置`
+* **CrudTable** `基于el-table封装,结合表单、表格设计器,动态配置,解放生产力`
 
-
-## 1、开始使用
+## 2. 开始使用
 * 使用npm安装依赖包
 ```
 npm i
@@ -45,17 +47,11 @@ TIPS: 若只启动前端项目,本地运行可以先将后端api地址修改为
 - VUE_APP_API_URL=http://localhost:3000/
 ```
 
-## 2、git commit lint规范
-```
- 参考angularJs标准提交规范
- 输入npm run cz提交
-```
-
-## 3、eslint规范
+## 3. eslint规范
 
 默认采用airbnb规范,规则详见 .eslintrc.js
 
-## 4、内置装饰器
+## 4. 内置装饰器
 有些场景使用装饰器比在代码里面硬编码显得更简单，比如防抖节流，确认提示等等，当前框架内置了一小部分装饰器，更多装饰器正在完善中。
 
 详见 @/decorator
@@ -70,7 +66,7 @@ confirmCallBack(){
  
 ```
 
-## 5、目录结构
+## 5. 目录结构
 
 ```bash
 ├── public                     # public文件夹
@@ -98,22 +94,21 @@ confirmCallBack(){
 └── package.json               # package.json
 ```
 
-## 6、TODO
-1. 完善后端配套项目
-
-## 7. 拉取代码时注意事项
+## 6. 拉取代码时注意事项
 ```
-提交时转换为LF，检出时不转换
+// 提交时转换为LF，检出时不转换
 git config --global core.autocrlf input
 ```
 ```
-设置为区分大小写
+// 设置为区分大小写
 git config core.ignorecase false
 ```
 
-## 8、Git提交规范
+## 7. Git提交规范
 
-## Git 提交规范
+``` 
+npm run cz
+```
 
 - 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
 
@@ -128,7 +123,8 @@ git config core.ignorecase false
   - `chore` 依赖更新/脚手架配置修改等
   - `ci` 持续集成
   
-## 0、 致谢
-@ytyang <ie07@163.com> 
+## 8. 致谢
+
+@ytyang
 
 @GavinZhuLei