docs: add usage example (#4)

* docs: add usage example * chore: add usage example in README.md * docs: use ```` instead of pre tag * chore: code block lang --------- Co-authored-by: yuyinws <[email protected]>
yuyinws · Aug 29, 2024 · 3ed4767 · 3ed4767
1 parent 8bca776
commit 3ed4767
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,29 @@ import 'virtual:group-icons.css'
 export default Theme
 ```
 
+### Usage Example
+````markdown
+::: code-group
+
+```sh [npm]
+npm install vitepress-plugin-group-icons
+```
+
+```sh [yarn]
+yarn add vitepress-plugin-group-icons
+```
+
+```sh [pnpm]
+pnpm add vitepress-plugin-group-icons
+```
+
+```sh [bun]
+bun add vitepress-plugin-group-icons
+```
+
+:::
+````
+
 ### Built-in Icons
 
 ```ts

diff --git a/docs/index.md b/docs/index.md
@@ -58,6 +58,30 @@ import 'virtual:group-icons.css'
 export default Theme
 ```
 
+## Usage Example
+
+````md
+::: code-group
+
+```sh [npm]
+npm install vitepress-plugin-group-icons
+```
+
+```sh [yarn]
+yarn add vitepress-plugin-group-icons
+```
+
+```sh [pnpm]
+pnpm add vitepress-plugin-group-icons
+```
+
+```sh [bun]
+bun add vitepress-plugin-group-icons
+```
+
+:::
+````
+
 ## Built-in Icons
 
 ::: code-group