chore: 完善说明

README.md

@@ -2,16 +2,19 @@
 ## 简介
 Me-admin template是一个免费开源的中后台模板,基于vue3、vite3、 pinia、 elment-plus构建，开箱即用。
 
+**中文** | [English](./README_EN.md)
+
+
 ## 特性
  - **基于vue3、vite3、pinia、elment-plus、vue-request@next**
- - **基于typescript**
+ - **基于typescript** 应用级JavaScript 的语言
  - **可配置主题** 可配置主题色及主题模式
  - **友好的国际化方案** 基于vue-i18n 支持按组件异步加载语言包。
  - **自定义keepAlive缓存** 可根据key进行vue keep-alive,解决不同路由统一组件不能独立刷新缓存问题
  - **权限** 内置完善的动态路由权限生成方案
  - **Mock 数据** 内置mock数据方案便于测试
- - **组件自动引入**
- - **便捷的类型自动生成**
+ - **组件自动引入** 自动按需引入components下的组件定义
+ - **便捷的类型自动生成** 自动生成ts type 最大程度减少工作量
 
 ## 预览
 - 完整版国外访问：[https://meadmin-cn.github.io/meadmin-template](https://meadmin-cn.github.io/meadmin-template)
@@ -75,7 +78,7 @@ git clone https://github.com/meadmin-cn/meadmin-template.git
 - 需符合 [commitlint](https://commitlint.js.org/#/concepts-commit-conventions)规范，建议安装`vscode`的`Conventional Commits`扩展
   - `feat`  新功能
   - `fix`  Bug 修复
-  - `chore` 其他
+  - `chore` 杂物处理
   - `docs` 文档更改
   - `style` 样式更改
   - `refactor` 重构

README_EN.md

@@ -0,0 +1,99 @@
+# Me-admin template
+## Introduction
+Me-admin template is a free open source admin template, built on VUE3, VitE3, Pinia, and Elment-Plus, right out of the box.
+
+**English** | [中文](./README.md)
+
+
+## Feature
+ - **Base on vue3、vite3、pinia、elment-plus、vue-request@next**
+ - **Base on typescript** The language of application-level JavaScript
+ - **Configurable Themes** Configurable theme color and theme mode
+ - **Friendly internationalisation scheme** Support for asynchronous loading of language packs by component based on vue-i18n.
+ - **Customize the keepAlive cache** Vue keep-alive can be performed according to the key to solve the problem that unified components of different routes cannot refresh the cache independently 
+ - **Permission** Built - in perfect dynamic route permission generation scheme
+ - **Mock** The built-in mock data scheme is easy to test
+ - **Component automatic introduction** Automatically introduces component definitions under Components as needed
+ - **Convenient automatic type generation** Automatically generating TS types minimizes the workload
+
+## Preview
+- Full version of the github site: [https://meadmin-cn.github.io/meadmin-template](https://meadmin-cn.github.io/meadmin-template)
+- Full version Chinese site: [https://meadmin-cn.gitee.io/meadmin-template](https://meadmin-cn.gitee.io/meadmin-template)
+
+## Documentation
+- Chinese site: [https://meadmin-cn.github.io/meadmin-template-doc](https://meadmin-cn.github.io/meadmin-template-doc)
+- github site: [https://meadmin-cn.gitee.io/meadmin-template-doc](https://meadmin-cn.gitee.io/meadmin-template-doc)
+
+## branch
+- [main](https://github.com/meadmin-cn/meadmin-template/tree/main) full edition
+- [template](https://github.com/meadmin-cn/meadmin-template/tree/template) foundation forms
+
+## warehouse
+- [Github](https://github.com/meadmin-cn/meadmin-template)
+- [Gitee](https://gitee.com/meadmin-cn/meadmin-template)
+
+## Install and use
+
+ nodejs version >= 16.15.1
+
+- clone code
+```
+git clone https://github.com/meadmin-cn/meadmin-template.git
+```
+- install
+```
+    cd meadmin-template
+    npm install
+```
+- run
+```
+    npm run dev
+```
+- build
+```
+    npm run build
+```
+
+## contribute
+
+- You are only allowed to contribute code to the main branch. The template branch is maintained by the author. If there is a bug in the template branch, the author will follow up. 
+- The main branch only allows code contributions to files (excluding language pack files)/ new files that are not in the Template branch 
+- Contribution code is unified on Github instead of Gitee 
+### Pull Request:
+1.Fork Code!
+
+2.Create your own branch: `git checkout -b feat/xxxx`
+
+3.initialize:(`npm run i`) or ( `npm install` `npx husky install`)
+
+4.eslint check：`npm run eslint`(Husky automatically runs ESLint, Prettier, and type-check, but it does not automatically fix ESLint WARN. You need to run WARN for editing )
+
+5.Commit: git commit -am 'feat: add xxxxx'
+
+6.push: `git push origin feat/xxxx`
+
+7.submit: `pull request`
+
+## Git Contribution Submission Specification
+- must comply with [commitlint](https://commitlint.js.org/#/concepts-commit-conventions) regulations，It is recommended that `vscode`'s `Conventional Commits` extension be installed
+  - `feat`  新功能
+  - `fix`  Bug 修复
+  - `chore` 杂物处理
+  - `docs` 文档更改
+  - `style` 样式更改
+  - `refactor` 重构
+  - `perf` 性能改进
+  - `test` 测试添加/更正
+  - `revert` 还原提交
+  - `ignore` 临时暂存可忽略
+  - `ci` CI发版
+
+## To admire the authors'
+
+The author is still struggling for the baby milk powder money, if you can help you welcome to tip .Make sure to note that Github Name will be maintained in the tip list later 
+
+![./payCode.jpg](https://gitee.com/meadmin-cn/meadmin-template/raw/main/payCode.jpg)
+
+
+## License
+[MIT © meadmin-cn](./LICENSE)

package.json

@@ -3,6 +3,11 @@
   "private": true,
   "version": "1.0.7",
   "type": "module",
+  "author": {
+    "name": "meadmin-cn",
+    "email": "yuntian001z@qq.com",
+    "url": "https://github.com/yuntian001"
+  },
   "scripts": {
     "format": "prettier --write --cache .",
     "dev": "vite",
@@ -75,6 +80,15 @@
     "vue-tsc": "^0.34.7",
     "xregexp": "^5.1.1"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meadmin-cn/meadmin-template.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/meadmin-cn/meadmin-template/issues"
+  },
+  "homepage": "https://github.com/meadmin-cn/meadmin-template",
   "lint-staged": {
     "**/*": "prettier --cache --write --ignore-unknown",
     "*.{vue,ts,tsx}": "eslint --cache"