From 4b3d622c7f6939c821c53b790133fd0fc2a0c0f4 Mon Sep 17 00:00:00 2001
From: miaosiyu <miaosiyu@sensesw.onaliyun.com>
Date: Sun, 3 Dec 2023 21:14:40 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md    | 46 +++-------------------------------------------
 op/README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 43 deletions(-)
 create mode 100644 op/README.md

diff --git a/README.md b/README.md
index f4f433b..6a3c74d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Flow / 同步组件文档
+# Flow / 同步组件开发文档
 
 ## op
 
@@ -11,51 +11,11 @@ const onSyncTask = async (config, env, op, eventData) => {
 };
 ```
 
-### IDMesh 接口封装
-
-op.api 封装了一系列 IDMesh 的接口请求。
-
-详情参见：[op.api 文档](./op/API.md)
-
-### 通知类
-
-op.notification 封装了通知操作。
-
-详情参见：[op.notification 文档](./op/Notification.md)
-
-### 网路请求
-
-op.request 封装了网络请求方法，你可以使用它调用第三方接口。
-
-详情参见：[op.request 文档](./op/Request.md)
-
-### 工具类
-
-op.utils 封装了一系列工具方法。
-
-详情参见：[op.utils 文档](./op/Utils.md)
-
-### Access 访问控制
-
-op.access 封装了访问控制操作。
-
-详情参见：[op.access 文档](./op/Access.md)
-
-### 日志打印
-
-使用 log 方法打印日志：
-
-``` js
-const onSyncTask = async (config, env, op, eventData) => {
-  op.api.init('<AK>', '<SK>');
-  const { data } = await op.api.user.disable({ id: '<User_ID>' });
-  log('用户禁用请求返回', new Date().toISOString(), data);
-};
-```
+详情参见：[op 文档](./op/README.md)
 
 ## Flow 场景文档
 
-详情参见：[op.access 文档](./flow/README.md)
+详情参见：[Flow 文档](./flow/README.md)
 
 
 
diff --git a/op/README.md b/op/README.md
new file mode 100644
index 0000000..b8a3e57
--- /dev/null
+++ b/op/README.md
@@ -0,0 +1,52 @@
+# op
+
+`op` 是为函数事件流、同步组件等一系列场景所提供的工具，可以使用它请求一系列 IDMesh 接口，使用它进行一系列数据处理等等。
+
+``` js
+const onSyncTask = async (config, env, op, eventData) => {
+  op.api.init('<AK>', '<SK>');
+  op.api.user.disable({ id: '<User_ID>' });
+};
+```
+
+### IDMesh 接口封装
+
+op.api 封装了一系列 IDMesh 的接口请求。
+
+详情参见：[op.api 文档](./op/API.md)
+
+### 通知类
+
+op.notification 封装了通知操作。
+
+详情参见：[op.notification 文档](./op/Notification.md)
+
+### 网路请求
+
+op.request 封装了网络请求方法，你可以使用它调用第三方接口。
+
+详情参见：[op.request 文档](./op/Request.md)
+
+### 工具类
+
+op.utils 封装了一系列工具方法。
+
+详情参见：[op.utils 文档](./op/Utils.md)
+
+### Access 访问控制
+
+op.access 封装了访问控制操作。
+
+详情参见：[op.access 文档](./op/Access.md)
+
+### 日志打印
+
+使用 log 方法打印日志：
+
+``` js
+const onSyncTask = async (config, env, op, eventData) => {
+  op.api.init('<AK>', '<SK>');
+  const { data } = await op.api.user.disable({ id: '<User_ID>' });
+  log('用户禁用请求返回', new Date().toISOString(), data);
+};
+```