make readme

AceMood · AceMood · commit 266e17621bbc · 2016-12-16T17:38:54.000+08:00
diff --git a/README.md b/README.md
@@ -151,75 +151,13 @@ __Miscellaneous__
 的less文件名改成`_`开头, 在产出时不会产生空文件. 另一种做法是配置扫描器的ignorePaths属性或者插件的ignore属性(内置插件都
 支持), 这个函数可以接受文件的工程路径作为参数, 返回true则表示忽略此资源. 
 
-### 配置
+### 配置 soi
 
-soi 通过命令行执行操作, 默认当前目录为所要扫描的工程目录。在配置文件中通过全局soi对象提供的api进行配置, 全部方法可以从[这里找到](./doc/soi.api.md), 常用方法有:
+**soi** 通过命令行执行操作, 默认当前目录为所要扫描的工程目录。在配置文件中通过全局soi对象提供的api进行配置, 全部方法可以从[这里找到](./doc/api/soi.md).
 
-### soi.addRule(pattern, option)
-
-* **pattern {string|Regexp}** 匹配模式, glob string或者正则
-* **option {object}**
-	* **to {function|string}** 线上路径
-
-为多个构建任务添加全局共享的打包路径规则, 例
-
-```
-soi.addRule(/src\/(.*)\/(.*)/, {
-	to : function($0, $1, $2) {
-    	return [domain + '/static', $1, $2].join('/');
-    }
-})
-```
-会匹配工程目录下路径类似`src/js/jquery.js`的所有资源, 将其线上打包路径设置为`https://s0.db.com/static/js/jquery.js`. addRule的第二个参数的`to`也可以为一个字符串配置, 例
-
-```
-soi.addRule(/src\/(.*)\/(.*)/, {
-	to: '/static/$1/'
-})
-```
-
-注意: 
-
-1. task.addRule第二个参数传字符串不用自己拼接domain的设置, soi会自动加上为task设置的domain属性. 但是如果第二个参数传函数就需要自己拼接.
-2. task.addRule第二个参数传字符串, 无需考虑文件名字, 只需指定目录即可, 若`to`最后未加上系统的目录分隔符, 构建工具也会自行加上
-
-
-### soi.config.get
-
-### soi.config.set
-
-### soi.release.task(name, option)
-
-* **name {string}** 构建任务的名称
-* **option {object}** 任务配置对象
-	* **dir {string}** 相对工程目录的目录地址, 用于存放打包后的静态文件
-    * **mapTo {string}** 相对工程目录的目录地址, 用于存放打包后的资源表文件
-    * **domain {string}** 资源线上cdn的地址, 如 'https://s0.bdstatic.com/'
-    * **scandirs {Array.<string>}** 扫描的相对工程目录的目录, 如 `['src']`
-    * **loaders {Array.<ResourceLoader>}** 要扫描的文件类型, 不同类型对应soi.Loaders的一个属性, 传入即可, 如 
-    
-    ``` javascript 
-    [
-    	new soi.Loaders.JSLoader(),
-    	new soi.Loaders.CSSLoader()
-    ]
-    ```
-    
-    * **pack {object}** 文件合并配置, 需要和packger插件配合使用, 配置是参考如下代码:
-     
-    ``` javascript
-    {
-          '/static/pkg/build.css': ['src/css/*.css'],
-          '/static/pkg/build.js': ['src/app/*.js']
-    }
-    ```
-      
-    * **preserveComments {boolean}** 打包是否保留注释
-
-生成一个release类型的task, 用于构建工程目录下的代码. 第一个参数传递task的名称, 第二个参数传递
-
-### soi.deploy.task
+### 配置 task
 
+**soi** 通过命令行执行操作, 默认当前目录为所要扫描的工程目录。在配置文件中通过全局soi对象提供的api进行配置, 全部方法可以从[这里找到](./doc/api/task.md).
 
 ## 预处理器
 
@@ -239,37 +177,7 @@ soi.addRule(/src\/(.*)\/(.*)/, {
 
 ## 插件体系
 
-soi 内部集成了如下插件, 无需安装其他模块可直接使用: 
-
-### modulewrapper
-
-结合[kerneljs](https://github.com/AceMood/kerneljs/)模块加载器的代码wrapper功能, 将普通代码封装为CommanJS格式。简单场景可以使用。
-
-### modux
-
-结合[modux](https://github.com/AceMood/modux/)模块加载器的代码wrapper功能, 将普通代码封装为amdJS格式。modux是最新的加载器实现, 基于资源表能够更好的和工程化结合, 提升异步加载速度以及模块定义相关操作的稳定性, gzip后该库大小在**1.4kb**左右。
-
-### uglifier
-
-
-
-### replacer
-
-
-
-### clean-css
-
-
-
-### idgenerator
-
-
-
-### fingerprint
-
-
-
-### packager
+soi 内部集成了前端构建常用插件, 无需安装其他模块可直接使用。包括对模块加载器[modux](https://github.com/AceMood/modux)的支持, js最小化的UglifyJS插件, css最小化的cleanCss插件等。更多说明请[移步这里](./doc/plugins.md)
 
 
 ## 最后
diff --git a/doc/api/soi.md b/doc/api/soi.md
@@ -0,0 +1,115 @@
+## 属性
+
+#### soi.Loaders
+
+
+
+## 方法
+
+#### soi.addRule(pattern, option): soi
+
+* **pattern {string|Regexp}** 匹配模式, glob string或者正则
+* **option {object}**
+	* **to {function|string}** 线上路径
+
+为多个构建任务添加全局共享的打包路径规则, 例
+
+```
+soi.addRule(/src\/(.*)\/(.*)/, {
+	to : function($0, $1, $2) {
+    	return [domain + '/static', $1, $2].join('/');
+    }
+})
+```
+会匹配工程目录下路径类似`src/js/jquery.js`的所有资源, 将其线上打包路径设置为`https://s0.db.com/static/js/jquery.js`. addRule的第二个参数的`to`也可以为一个字符串配置, 例
+
+```
+soi.addRule(/src\/(.*)\/(.*)/, {
+	to: '/static/$1/'
+})
+```
+
+注意: 
+
+1. task.addRule第二个参数传字符串不用自己拼接domain的设置, soi会自动加上为task设置的domain属性. 但是如果第二个参数传函数就需要自己拼接.
+2. task.addRule第二个参数传字符串, 无需考虑文件名字, 只需指定目录即可, 若`to`最后未加上系统的目录分隔符, 构建工具也会自行加上
+
+#### soi.addCompiler(resourceType, compiler): void
+
+* **resourceType {string}** 资源类型, 可以是css, js, image, font的一种或自定义的类型
+* **compiler {object}** 编译函数对象
+
+针对特定类型资源添加编译函数. compiler对象必须含有`exec`的函数, 在编译过程中, 流程会将当前编译资源resource, 
+当前资源表对象task.map, 线上路径生成规则hit, 以及构建流程自身task通过形参传递给`exec`函数完成编译. 
+
+一般情况下不需要覆盖常规的资源类型的编译对象, soi内置的编译函数会妥当处理资源的编译. 若需要添加自定义类型则可参考
+[js compiler](https://github.com/Saber-Team/soi/blob/master/lib/compiler/js.js).
+
+#### soi.getCompiler(resourceType): compiler
+
+返回特定资源的编译器对象. compiler只是一个Object的实例且包含`exec`方法.
+
+#### soi.config.get
+
+#### soi.config.set
+
+#### soi.release.task(name, option): ReleaseTask
+
+* **name {string}** 构建任务的名称
+* **option {object}** 任务配置对象
+	* **dir {string}** 相对工程目录的目录地址, 用于存放打包后的静态文件
+    * **mapTo {string}** 相对工程目录的目录地址, 用于存放打包后的资源表文件
+    * **domain {string}** 资源线上cdn的地址, 如 'https://s0.bdstatic.com/'
+    * **scandirs {Array.\<string\>}** 扫描的相对工程目录的目录, 如 `['src']`
+    * **loaders {Array.<ResourceLoader>}** 要扫描的文件类型, 不同类型对应soi.Loaders的一个属性, 传入即可, 如 
+    
+    ``` javascript 
+    [
+    	new soi.Loaders.JSLoader(),
+    	new soi.Loaders.CSSLoader()
+    ]
+    ```
+    
+    * **pack {object}** 文件合并配置, 需要和packger插件配合使用, 配置是参考如下代码:
+     
+    ``` javascript
+    {
+    	'/static/pkg/build.css': ['src/css/*.css'],
+        '/static/pkg/build.js': ['src/app/*.js']
+    }
+    ```
+      
+    * **preserveComments {boolean}** 打包是否保留注释
+
+返回生成的release类型的task, 用于构建工程目录下的代码. ReleaseTask的相关API可以[看这里](./doc/api/task.md)
+
+#### soi.deploy.task(name, option): DeployTask
+
+* **name {string}** 构建任务的名称
+* **option {object}** 任务配置对象
+	* **dir {string}** 相对工程目录的目录地址, 用于存放打包后的静态文件
+    * **mapTo {string}** 相对工程目录的目录地址, 用于存放打包后的资源表文件
+    * **domain {string}** 资源线上cdn的地址, 如 'https://s0.bdstatic.com/'
+    * **scandirs {Array.\<string\>}** 扫描的相对工程目录的目录, 如 `['src']`
+    * **loaders {Array.<ResourceLoader>}** 要扫描的文件类型, 不同类型对应soi.Loaders的一个属性, 传入即可, 如 
+    
+    ``` javascript 
+    [
+    	new soi.Loaders.JSLoader(),
+    	new soi.Loaders.CSSLoader()
+    ]
+    ```
+    
+    * **pack {object}** 文件合并配置, 需要和packger插件配合使用, 配置是参考如下代码:
+     
+    ``` javascript
+    {
+    	'/static/pkg/build.css': ['src/css/*.css'],
+        '/static/pkg/build.js': ['src/app/*.js']
+    }
+    ```
+      
+    * **preserveComments {boolean}** 打包是否保留注释
+    * **watch {boolean}** 是否实时根据代码改动进行构建
+
+返回生成的release类型的task, 用于构建工程目录下的代码. DeployTask的相关API可以[看这里](./doc/api/task.md)
diff --git a/doc/api/task.md b/doc/api/task.md
diff --git a/doc/plugins.md b/doc/plugins.md
@@ -0,0 +1,31 @@
+## modulewrapper
+
+结合[kerneljs](https://github.com/AceMood/kerneljs/)模块加载器的代码wrapper功能, 将普通代码封装为CommanJS格式。简单场景可以使用。
+
+## modux
+
+结合[modux](https://github.com/AceMood/modux/)模块加载器的代码wrapper功能, 将普通代码封装为amdJS格式。modux是最新的加载器实现, 
+基于资源表能够更好的和工程化结合, 提升异步加载速度以及模块定义相关操作的稳定性, gzip后该库大小在**1.4kb**左右。
+
+## uglifier
+
+js代码压缩工具
+
+## replacer
+
+
+
+## clean-css
+
+css代码压缩工具
+
+## idgenerator
+
+
+
+## fingerprint
+
+为静态资源打上唯一名标识, 且将代码中的引用地址全部替换. 在PC的产品中, 可以为资源加上大于1个月的强缓存头提升二次浏览性能.
+在移动端项目中可以根据唯一版本号生成service-worker或者localStorage的缓存版本.
+
+## packager
diff --git a/doc/soi.api.md b/doc/soi.api.md
diff --git a/soi.js b/soi.js
@@ -3,25 +3,8 @@
  *
  * Copyright (c) 2016 Saber-Team
  *
- * 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.
- *
  * @author AceMood
+ * @email zmike86@gmail.com
  */
 
 'use strict';
