chore: update readme && add lock file

.gitignore

@@ -14,7 +14,6 @@ temp*
 coverage
 test-report.html
 .idea/
-yarn.lock
 yarn-error.log
 *.zip
 .history

README.md

@@ -1,101 +1,118 @@
 
 <p style="display:flex; justify-content: center">
 
-[![](https://tdesign.gtimg.com/starter/brand-logo.svg)](http://tdesgin.tencent.com/starter/vue/#/dashboard/base)
-
 </p>
 <p align="center">
-  <a href="https://npmjs.com/package/vite"><img src="https://img.shields.io/npm/v/vite.svg" alt="npm package"></a>
+  <a href="https://tdesign.tencent.com/starter/vue-next/#/dashboard/base" target="_blank">
-  <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatility"></a>
+    <img alt="TDesign Logo" width="200" src="https://tdesign.gtimg.com/starter/brand-logo.svg">
+  </a>
 </p>
 
-# TDesign Starter
+<p align="center">
+  <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatility"></a>
+  <a href="https://github.com/Tencent/tdesign-vue-next/blob/develop/LICENSE">
+    <img src="https://img.shields.io/npm/l/tdesign-vue-next.svg?sanitize=true" alt="License">
+  </a>
+</p>
 
-## 项目简介
+### 项目简介
 
-TDesign Starter 基于 TDesign UI 组件，旨在提供项目开箱即用的、配置式的并且拥有开发体验和设计感的中后台的项目。
+TDesign Starter 是一个基于 TDesign。使用 vite2，TypeScript 开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。
 
-- 设计美观
+<p>
-  - 基于 TDesign UI 设计规范
+  <a href="http://tdesign.tencent.com/starter/vue-next/">在线预览</a>
-  - 提供 Figma、 Sketch、 Adobe XD、 Axure等多种类型的设计资源
+  .
-  - 在开源体系上打造具有自身品牌特色且好用的产品
+  <a href="https://tdesign.tencent.com/starter/">使用文档</a>
-<br/>
-- 完备路由
-  - 同时支持配置式路由和自定义路由
-  - 对于配置型路由，提供导航类组件的深度定制（“菜单 Menu”、“面包屑 Breadcrumb”），无需手动处理路由映射关系。
-<br/>
-- 动态布局:
-  - 内置“左右布局”、“上左右布局”、“上下布局”等中后台常用布局，
-  - 页面内容基于 24 栅格布局设计，内置“常规型”和“紧凑型”两种间距模式
-<br/>
-- 极速HRM:
-  - 采用 `Vite` 构建
-  - 开发环境下体验浏览器 esmodule bundless, 达到极速更新，无需等待漫长的 bundle 过程
-<br/>
-- 开发规范:
-  - 统一规范会减少沟通成本，提高开发和维护的体验；
-  - 提交规范采用 `Angular commit 规范`
-  - 同时推荐采用 `vscode` 开发
-<br/>
 
-## 项目脚本
+</p>
+<p>
+  <img src="https://tdesign.gtimg.com/starter/starter.png" style="border-radius:6px;border:1px solid var(--component-border)"/>
+</p>
 
+### 特性
+
+- 内置多种常用的中后台页面
+- 完善的目录结构
+- 完善的代码规范配置
+- 支持暗黑模式
+- 自定义主题颜色
+- 多种空间布局
+- 内置 Mock 数据方案
+
+### 使用
+
+> 通过 `tdesign-starter-cli` 初始化项目仓库
+
+```bash
+## 1、安装 tdesign-starter-cli
+npm i tdesign-starter-cli@latest -g
+
+## 2、创建项目
+td-starter init
 ```
-// 安装依赖
+
+### 开发
+
+``` bash
+## 安装依赖
 npm install
 
-// 启动项目
+## 启动项目
 npm run dev
-
-// 项目构建 - 体验环境
-npm run build:test
-
-// 项目构建
-npm run build
-
-// 项目预览
-npm run preview
-
-// 项目 eslint
-npm run lint
-
-// 修复 eslint
-npm run lint:fix
-
-// 项目 stylelint
-npm run stylelint
-
-// 修复 stylelint
-npm run stylelint:fix
-
 ```
 
-<br/>
+### 构建
 
-## 布局
+```bash
+## 构建正式环境
+npm run build
 
-网站布局支持“空布局”， “侧边栏导航布局”， “侧边栏布局加头部导航”，“头部导航”四种；布局文件地址在<a href="./src/layouts">src/layouts</a>
+## 构建测试环境
+npm run build:test
+```
 
-更多定制化布局，推荐使用 TDesign UI layout
+### 其他
 
-- ```<t-layout>```
+```bash
-- ```<t-header>```
+## 预览构建产物
-- ```<t-footer>```
+npm run preview
-- ```<t-aside>```
-- ```<t-content>```
 
-<br/>
+## 代码格式检查
+npm run lint
 
-## 提交规范
+## 代码格式检查与自动修复
+npm run lint:fix
 
-整齐美观的提交规范，沟通维护更加省力 [Angular Git Commit Guidelines](https://zj-git-guide.readthedocs.io/zh_CN/latest/message/Angular%E6%8F%90%E4%BA%A4%E4%BF%A1%E6%81%AF%E8%A7%84%E8%8C%83/)
+## style格式检查
+npm run stylelint
 
-<br/>
+## style格式检查与自动修复
+npm run stylelint:fix
+```
 
-## 兼容性
+### 如何贡献
 
-| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari |
+非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。
+
+#### Pull Request
+
+1. Fork 代码!
+2. 创建自己的分支: `git checkout -b feat/xxxx`
+3. 提交你的修改: `git commit -a 'feat(project): describe'`
+4. 推送您的分支: `git push origin feat/xxxx`
+5. 提交 `pull request`
+
+#### 贡献提交规范
+
+- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
+- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
+
+### 兼容性
+
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)</br>Safari |
 | --------- | --------- | --------- | --------- |
-| Edge >=16 | Firefox >=60| Chrome >=61| Safari >=11
+| IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions |
 
-<br/>
+### License
+
+[MIT](./LICENSE)