mp-darkmode 1.0.9 → 1.1.0-beta.2

package/README.md

@@ -59,6 +59,16 @@ Darkmode.run(document.body.querySelectorAll('*'), {
 
 More detailed usage can refer to [API](./doc/en/API.md).
 
+## Plugins
+
+Plugins are supported since `v1.1.0`. Custom actions can be performed during transformation, such as filtering DOM attributes. How to use the plugin is as follows:
+
+```javascript
+Darkmode.extend([pluginA, pluginB, pluginC]);
+```
+
+If you want to write your own Dark Mode plugin, you can refer to [here](./doc/en/plugins.md)。
+
 ## Contribution
 
 The algorithm is constantly updated and optimized. If you have a good idea, you can fork and submit your code. For specific development, please refer to [Development Guide](./doc/en/develop.md).

package/README_CN.md

@@ -43,13 +43,13 @@ Darkmode.run(document.body.querySelectorAll('*')); // 处理body下的所有DOM
 
 ### `Darkmode.run(nodes[, options])`
 
-- `nodes` <DOM Object Array> 要进行Dark Mode转换的DOM节点数组。
-- `options` <Object> Dark Mode转换算法配置项。
-  - `options.error` <Function> 发生error时触发的回调。
+- `nodes` <DOM Object Array> 要进行 Dark Mode 转换的 DOM 节点数组。
+- `options` <Object> Dark Mode 转换算法配置项。
+  - `options.error` <Function> 发生 error 时触发的回调。
     - `err` <Error> 错误对象。
-  - `options.mode` <string> 强制指定的颜色模式（dark | light），指定了就不监听系统颜色。
+  - `options.mode` <string> 强制指定的颜色模式（ dark | light ），指定了就不监听系统颜色。
 
-运行Dark Mode转换算法。
+运行 Dark Mode 转换算法。
 
 ```javascript
 Darkmode.run(document.body.querySelectorAll('*'), {
@@ -57,7 +57,17 @@ Darkmode.run(document.body.querySelectorAll('*'), {
 });
 ```
 
-更多详细用法可参考[API](./doc/cn/API.md)。
+更多详细用法可参考 [API](./doc/cn/API.md)。
+
+## 插件
+
+从 `v1.1.0` 开始支持插件，可以在转换过程中进行自定义操作，比如过滤 DOM 属性。插件的使用方法如下：
+
+```javascript
+Darkmode.extend([pluginA, pluginB, pluginC]);
+```
+
+如果你想编写自己的 Dark Mode 插件，可以参考[这里](./doc/cn/plugins.md)。
 
 ## 处理原则