From 59588d5b6237ede69607361c0f9cbbe1c3dabe62 Mon Sep 17 00:00:00 2001
From: lcxfs1991 <lcxfs1991@gmail.com>
Date: Wed, 22 Jun 2016 16:06:20 +0800
Subject: [PATCH] add README

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 78 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4b7ad02..959a6ad 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,85 @@
 ## 起因
 以前做项目的时候，由于重构的，或者尝试新的框架的关系，主体页面可能出现多种框架，管理起来不方便，不便如下：
 * 启动开发环境的时候，需要多个命令
-* 发布前的编译文件，同时放到一个文件夹里比较麻烦，需要另外写一套外层构建
+* 发布的时候，同时放到一个文件夹里比较麻烦，需要另外写一套外层构建
 * node_modules包管理不方便，比较多的冗余
 
 
+## 特点
+* 一键进行开发以及生成编译好的文件
+* 减少node_modules包冗余
+
+## 配置
+
+下面就是基本的配置
+```
+var steamerConfig  = {
+	projects: {   					// 项目具体配置
+		react: {  					// react项目
+			src: "./react/",		// 源代码文件夹
+			cmds: {					// 运行命令，主要包括开发dev和发布的pub
+				dev: "npm run dev", 
+				pub: "npm run pub",
+			},
+		},
+		model: {					// model项目
+			src: "./model/",
+			cmds: {
+				dev: "npm run dev",
+				pub: "npm run pub",
+			},
+		},
+		node: {						// node项目
+			src: "./node/",
+			cmds: {
+				dev: "npm start",
+				pub: " ",			// 对于一些node项目，可能没有这个命令，因为不用编译
+			},
+		},
+	},
+	steps: {								// 针对命令的回调
+		dev: {								// 开发命令
+			start: function(config) {		// 命令开始
+
+			},
+			finish: function(config) {		// 命令结束
+				
+			}
+		},
+		pub: {								// 发布命令
+			start: function(config) {		// 命令开始
+				
+			},
+			finish: function(config) {      // 命令结束
+				
+				console.log(config.isEnd);
+
+
+			}
+		},
+	}
+};
+
+module.exports = steamerConfig;
+```
+
+针对命令的回调，会传入针对某一命令传入对应的steamerConfig，但会添加如下属性
+
+* ```currentProject```，表示是哪一个项目的命令开始/结束
+* ```isEnd```，只出现在finish回调中，若为true，则表示所有项目的命令都已经结束
+
+有了以上的回调，就可以进行一些命令开始前或结束后的操作，例如发布命令悉数结束后，可以将编译文件再拷贝一份进行离线包的打包
+
+
+## package.json的变化
+在此文件中，若使用stearm --install命令，子项目中可能会多出现dependenciesBk和devDependenciesBk。这2个用于备份之前的node_modules包设置。因为使用此安装命令，会将重复配置转移动主项目的package.json中，以减少冗余。
+
+
+## 使用
+
+steamer --dev 启动开发命令
+
+steamer --pub 启动发布命令
+
+steamer --install 进行项目的node_modules包安装和package.json配置
 
-npm link
\ No newline at end of file