From 08a188f375a6b988d42c91c1c93abbfad05a1128 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=A8=E5=81=B6?= <2424880409@qq.com> Date: Tue, 22 Jun 2021 21:13:16 +0800 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e776701..56a1d66 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ ![image](https://user-images.githubusercontent.com/21073039/122888869-d6e60d00-d374-11eb-9fb9-2a6e541e389e.png) -# utools 插件支持 -## plugin.json +## utools 插件支持 +### plugin.json 在你觉得合适的地方新建一个文件夹,并创建 `plugin.json` 文件。这是最重要的一个文件,用来说明这个插件将如何与 `rubick` 集成,最基本的格式如下: ```json { @@ -25,11 +25,11 @@ ``` 所有字段和 `utools` 保持一致,这将可以完美使用`utools`的插件生态 -# utools api 支持 +## utools api 支持 -## 事件 +### 事件 -### onPluginReady(callback) +#### onPluginReady(callback) * `callback` Function > 当插件装载成功,uTools 将会主动调用这个方法(生命周期内仅调用一次),所有的 `api` 都应该在 `onPluginReady` 之后进行调用。 @@ -42,7 +42,7 @@ utools.onPluginReady(() => { }) ``` -### onPluginEnter(callback) +#### onPluginEnter(callback) * `callback` Function > 每当插件从后台进入到前台时,uTools 将会主动调用这个方法。 @@ -57,15 +57,15 @@ utools.onPluginEnter(({code, type, payload, optional}) => { 更多可以参考 `utools` 文档:https://u.tools/docs/developer/api.html#%E4%BA%8B%E4%BB%B6 -## 窗口交互 +### 窗口交互 -## 本地数据库 +### 本地数据库 类似于 `utools` 的功能,我们也提供了本地数据库的 api 能力 -### utools.db.put(doc) +#### utools.db.put(doc) -#### 示例 +##### 示例 ```js // 创建请求 utools.db.put({ @@ -83,11 +83,11 @@ utools.db.put({ ``` -### utools.db.get(id) -### utools.db.remove(doc) -### utools.db.bulkDocs(docs) +#### utools.db.get(id) +#### utools.db.remove(doc) +#### utools.db.bulkDocs(docs) -## ubrowser +### ubrowser 可编程浏览器 ```js @@ -100,6 +100,6 @@ utools.db.put({ }) ``` -## 最后 +### 最后 utools过于强大,目前还没有完全实现其所有功能,不过我们会根据需要不断更新。欢迎小伙伴一起 `pr` 或 `star`