coding

README.md

-## pigx 2.0
-[pigx 2.0 部署文档](doc/md/deploy.md)  
-[pigx 2.0 新特性说明  ](https://www.bilibili.com/video/av37786337)   
-[pigx 2.0 从检出到启动](https://www.bilibili.com/video/av37695530)  
-[pigx pro新建微服务模块（一）](https://www.bilibili.com/video/av37737139)  
-[pigx pro新建微服务模块（二）](https://www.bilibili.com/video/av37740030)  
-[pigx pro新建微服务模块（三）](https://www.bilibili.com/video/av37743341)  
-[pigx pro新建微服务模块（四）](https://www.bilibili.com/video/av37774264)  
+# 毫末科技Pig UI企业版模板项目
 
+#### 作者：胡小根
+#### 邮箱：hxg@haomo-studio.com
 
-## 协议和授权
+## 1 概述
 
-pigX并非一个开源软件，作者保留全部的权利。
+本项目基于[pig-ui](https://gitee.wang/pig/pigx-ui)
 
-### 🌹权益
+### 1.1 版本要求
 
-1. 个人使用
-2. 允许用于学习、毕设等。
+```
+node >= 8.10.0
+npm >= 6.4
+```
 
-### 🚫禁止  
+## 2 使用
 
-1. 将本项目的部分或全部代码和资源进行任何形式的再发行（尤其上传GitHub、Gitee ）
-2. 利用本项目的部分或全部代码和资源进行`任何商业行为`
+公司Demo地址：http://pig.haomo-tech.com
 
-## 贡献代码
+### 2.1 安装
 
-pigX并非一个开源项目，也不是社区共同创造，其全部功能由作者独立完成。
+```
+npm install
+```
 
-如果你愿意放弃所有权利，并将权利无条件转让给pigX作者，欢迎您贡献代码,当然会给予不等金额奖励。
+### 2.2 使用
 
-## 提交反馈
+#### 2.2.1 开发调试
 
-1. 欢迎提交 issue，请写清楚遇到问题的原因，浏览器和操作系统环境，重现的流程。
-如果有开发能力，建议在本地调试出出错的代码。
+```
+npm run dev
+```
 
-2. 不接受`功能请求`的 issue，功能请求可能会被直接关闭，请谅解（正确的方式是打赏并附言）。
+#### 2.2.2 部署
 
+```bash
+npm run build
+npm run deploy  #  请每个项目上务必修改package.json里的部署地址
+```
+
+### 2.3 开发规范
+
+#### 2.3.1 组件开发要求
+
+#### 2.3.2 路由配置要求
+
+* 路由必须是英文单词，且必须是中间横线分隔，如 /my-book
+
+## 3 参考
+
+* [pig-ui](https://gitee.com/log4j/pig-ui)
+* [Pig Microservice Architecture](https://pig4cloud.com)
\ No newline at end of file

old-README.md

+## pigx 2.0
+[pigx 2.0 部署文档](doc/md/deploy.md)  
+[pigx 2.0 新特性说明  ](https://www.bilibili.com/video/av37786337)   
+[pigx 2.0 从检出到启动](https://www.bilibili.com/video/av37695530)  
+[pigx pro新建微服务模块（一）](https://www.bilibili.com/video/av37737139)  
+[pigx pro新建微服务模块（二）](https://www.bilibili.com/video/av37740030)  
+[pigx pro新建微服务模块（三）](https://www.bilibili.com/video/av37743341)  
+[pigx pro新建微服务模块（四）](https://www.bilibili.com/video/av37774264)  
+
+
+## 协议和授权
+
+pigX并非一个开源软件，作者保留全部的权利。
+
+### 🌹权益
+
+1. 个人使用
+2. 允许用于学习、毕设等。
+
+### 🚫禁止  
+
+1. 将本项目的部分或全部代码和资源进行任何形式的再发行（尤其上传GitHub、Gitee ）
+2. 利用本项目的部分或全部代码和资源进行`任何商业行为`
+
+## 贡献代码
+
+pigX并非一个开源项目，也不是社区共同创造，其全部功能由作者独立完成。
+
+如果你愿意放弃所有权利，并将权利无条件转让给pigX作者，欢迎您贡献代码,当然会给予不等金额奖励。
+
+## 提交反馈
+
+1. 欢迎提交 issue，请写清楚遇到问题的原因，浏览器和操作系统环境，重现的流程。
+如果有开发能力，建议在本地调试出出错的代码。
+
+2. 不接受`功能请求`的 issue，功能请求可能会被直接关闭，请谅解（正确的方式是打赏并附言）。
+