From 3ed4767b457e7ad6df6612f33b6e2f92085d0c7a Mon Sep 17 00:00:00 2001
From: fxzer <68853957+fxzer@users.noreply.github.com>
Date: Thu, 29 Aug 2024 14:07:04 +0800
Subject: [PATCH] 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 <lyc657508366@gmail.com>
---
 README.md     | 23 +++++++++++++++++++++++
 docs/index.md | 24 ++++++++++++++++++++++++
 2 files changed, 47 insertions(+)

diff --git a/README.md b/README.md
index aa112af..7518c24 100644
--- 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
index 6b91446..a30d036 100644
--- 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