更新README和完善部署命令

README.md

@@ -26,7 +26,13 @@
 
 ## 目标与哲学
 
-为您设计的项目，写下初衷、理念和目标。对创建和维护项目背后的动机，作简短的阐述，这应该可以解释为什么该项目存在。
+想做一个node+typescript+koa的服务层，用来满足一部分前端的需求，从而在无后端的情况下实现一套服务。
+
+内置满足多种需求的服务，比如网关、服务代理、静态服务器、api服务、websocket服务等等
+
+内置多种按需引入的插件（目前没有分离出插件包的打算，因为只是简单的再次封装一下，后续看情况再说），目前有`redis`,`log4js`,`nedb`
+
+**api服务**这块目前是使用restful风格
 
 ## 先决条件
 
@@ -40,7 +46,10 @@
 - [x] 开发环境热更新和生产环境pm2部署
 - [ ] mysql插件
 - [ ] mongo插件
+- [ ] 邮件系统插件
+- [ ] excel/word等导入/导出功能的插件
 - [ ] 可拔插插件和插件之间依赖兼容处理
+- [ ] 加密服务的完善（目前只有针对id的加解密，后续拓展MD5、hash等加密方式）
 - [ ] websocket服务完善
 - [ ] 项目结构和代码优化调整
 
@@ -54,13 +63,24 @@ yarn install
 
 ## 用法
 
-#### 启动
+#### 生产编译和启动
 
 ```bash
-yarn start
+# 生产编译
+yarn run compile
+# 普通启动
+node dist/app.js
+# pm2 守护进程启动
+yarn run pm2:start
+# pm2 list
+yarn run pm2:list
+# pm2 stop
+yarn run pm2:stop
+# pm2 restart
+yarn run pm2:restart
 ```
 
-自由地使用示例，并尽可能显示预期的输出。内联您可以演示的最小用法示例很有帮助，同时提供指向更复杂示例的链接（如果它们太长而无法合理地包含在自述文件中）。
+将`typescript`代码编译成`javascript`放在dist目录下，然后运行服务
 
 #### 开发
 
@@ -68,7 +88,7 @@ yarn start
 yarn dev
 ```
 
-自由地使用示例，并尽可能显示预期的输出。内联您可以演示的最小用法示例很有帮助，同时提供指向更复杂示例的链接（如果它们太长而无法合理地包含在自述文件中）。
+通过`nodemon`在内存中将`typescript`编译成`javascript`，并运行服务，同时监听变动的文件并重启服务
 
 ## 屏幕截图（可选）
 

package.json

@@ -20,7 +20,7 @@
   "license": "MIT",
   "scripts": {
     "dev": "cross-env NODE_ENV=development nodemon -e ts --exec ts-node -r tsconfig-paths/register src/app.ts",
-    "start": "rm -rf ./dist && cross-env NODE_ENV=prod tsc --inlineSourceMap false",
+    "compile": "rm -rf ./dist && cross-env NODE_ENV=prod tsc --inlineSourceMap false",
     "pm2:start": "pm2 start ./pm2.config.js",
     "pm2:list": "pm2 list",
     "pm2:stop": "pm2 stop gateway && pm2 delete gateway",