From 873a16ffc43addcde8af533b90ba3fd2ebfe5ebd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8A=A0=E9=87=8C?= <xiaofeng.mxf@taobao.com>
Date: Mon, 24 Nov 2014 16:25:37 +0800
Subject: [PATCH] add readme for rule samples

---
 README.md             |  2 +-
 rule_sample/README.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 1 deletion(-)
 create mode 100644 rule_sample/README.md

diff --git a/README.md b/README.md
index 644c538..3128a72 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,7 @@ Rule module
 ![](https://t.alipayobjects.com/images/T1v8pbXjJqXXXXXXXX.png)
 
 
-Using https features
+Https features
 ----------------
 After configuring rootCA, anyproxy could help to decrypt https requests, whose approach is also called Man-In-The-Middle(MITM).
 
diff --git a/rule_sample/README.md b/rule_sample/README.md
new file mode 100644
index 0000000..7a8eabb
--- /dev/null
+++ b/rule_sample/README.md
@@ -0,0 +1,32 @@
+The following are sample rules.
+
+* rule__blank.js
+    * blank rule file with some comments. You may read this before writing your own rule file.
+    * 空白的规则文件模板,和一些注释
+* rule_adjust_response_time.js
+    * delay all the response for 1500ms
+    * 把所有的响应延迟1500毫秒
+* rule_allow_CORS.js
+    * add CORS headers to allow cross-domain ajax request
+    * 为ajax请求增加跨域头
+* rule_assign_ip_address.js
+    * assign an ip address to a specified domain
+    * 为某个域名指定ip地址
+* rule_intercept_some_https_requests.js
+    * intercept https requests toward github.com and append some data
+    * 截获github.com的https请求,再在最后加点文字
+* rule_remove_cache_header.js
+    * remove all cache-related headers from server
+    * 去除响应头里缓存相关的头
+* rule_replace_request_option.js
+    * replace request parameters before sending to the server
+    * 在请求发送到服务端前对参数做一些调整
+* rule_replace_response_data.js
+    * modify response data
+    * 修改响应数据
+* rule_replace_response_status_code.js
+    * replace server's status code
+    * 改变服务端响应的http状态码
+* rule_use_local_data.js
+    * map some requests to local file
+    * 把图片响应映射到本地
\ No newline at end of file