From a24ea40d023c22927f32638643f8914a4c96ec10 Mon Sep 17 00:00:00 2001
From: pengzhanbo <volodymyr@foxmail.com>
Date: Sun, 26 Feb 2023 16:51:10 +0800
Subject: [PATCH] docs(plugin-iconify): update doc

---
 packages/plugin-iconify/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/packages/plugin-iconify/README.md b/packages/plugin-iconify/README.md
index f2b134d2..a637038f 100644
--- a/packages/plugin-iconify/README.md
+++ b/packages/plugin-iconify/README.md
@@ -1,5 +1,7 @@
 # `@vuepress-plume/vuepress-plugin-iconify`
 
+添加 `iconify` 图标库支持。并注入全局组件 `<Iconify>`
+
 ## Install
 ```
 yarn add @vuepress-plume/vuepress-plugin-iconify
@@ -16,3 +18,23 @@ module.exports = {
   // ...
 }
 ```
+
+## Options
+
+```ts
+interface IconifyOptions {
+  /**
+   * 组件名， 默认 `Iconify`
+   */
+  componentName?: string
+  color?: string
+  size?: string | number
+}
+
+```
+
+## Component
+
+```vue
+<Iconify name="material-symbols:home" color="currentColor" size="1em" />
+```