初始版本

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 樊小书生
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,29 +1,57 @@
 # vue-cli-element-starter
 
-## Project setup
-```
-yarn install
-```
+vue-cli 和 element 结合的项目开发模板，主要内容如下（后续新增的内容会在其后使用方括号标识添加时间）：
+
+1. 将 `axios` 或者 `$axios` 添加到 `Vue.prototype` ，对 `axios` 的封装是基于 [vue-cli-plugin-axios](https://www.npmjs.com/package/vue-cli-plugin-axios) 插件。
+2. 对 `axios` 的拦截器进行配置，调用 `axios` 发送请求的时候自动添加 `loading` 效果，请求返回的时候，判断请求内容的正确，错误的话直接提示错误信息。
+3. 并发请求时，只有当最后一个请求完成的时候才会关闭 `loading` 效果。
+4. 添加在路由切换的时候取消上个页面未完成的 `axios` 请求。
+5. 添加本地代理 [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware) 及相应的配置说明。
+6. 添加工具文件 `findComponents.js` ，看名字应该就知道是查找组件的相关方法，如需使用请自行引入。  [2019-04-20]
+7. 添加 `normalize.css` 和 `common.scss` ，如需使用请自行引入。  [2019-04-20]
+8. 增加自定义参数： [2019-05-19]
+   1. `showLoading`: 是否需要 `loading` 加载，至于样式仍是有你自由控制。
+   2. 关于在短时间内发送多条相同请求处理逻辑的相关字段：
+      1. 本插件默认是按照仅保留最初的发送请求链接。
+      2. `needLast`: 需要最新的发送请求链接，以前发送的可以直接 cancel ，这种情况一般适用于搜索框发送请求。
+      3. `needAll`: 所有的发送请求链接都需要
+
+## 模板说明
+
+1. 本模板暂时的技术栈为： vue + vue-cli + vue-router + vuex + element-ui + axios + sass（如果你使用的是其他的css预编译器请自行配置）
+
+## 项目使用
+
+1. 先将本项目 Fork 到你的 github ，方便日后你对其进行修改。
+2. 将你 github 上的远程库克隆到本地。
+
+或者是将本项目克隆到本地，去除远程库，再添加你自己的远程库：
 
-### Compiles and hot-reloads for development
 ```
-yarn run serve
+git remote rm origin
+git remote add origin <远程库地址>
 ```
 
-### Compiles and minifies for production
+### 安装依赖及插件
+
 ```
-yarn run build
+npm install
 ```
 
-### Run your tests
+### 启动开发模式（热更新）
+
 ```
-yarn run test
+npm run serve
 ```
 
-### Lints and fixes files
+### 生产模式打包
+
 ```
-yarn run lint
+npm run build
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+### 更多详细配置
+
+请看 [Configuration Reference](https://cli.vuejs.org/config/)。
+
+如果你使用的是 `vue ui` ，会发现项目名称可能不是你需要的，这个时候只需要将 `package.json` 和 `package-lock.json` 文件中的 `name` 修改为你希望的名称。