Add icons page to react-icons package readme

wso2 · Jul 11, 2023 · fa3f949 · fa3f949
1 parent d497af4
commit fa3f949
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,8 @@
 dist
 tmp
 /out-tsc
+.next
+next-env.d.ts
 
 # dependencies
 node_modules

diff --git a/packages/react-icons/README.md b/packages/react-icons/README.md
@@ -10,15 +10,23 @@
 
 ## Installation
 
+With npm
+
 ```bash
-# With npm
 npm install @oxygen-ui/react-icons
+```
+
+With pnpm
 
-# With pnpm
+```bash
 pnpm add @oxygen-ui/react-icons
+```
 
-# With yarn
+With yarn
+
+```bash
 yarn add @oxygen-ui/react-icons
+```
 
 ## Usage
 
@@ -43,6 +51,8 @@ The `@oxygen-ui/react-icons` package exports all the available icons as React co
 - `ChevronRightIcon`
 - ... and more!
 
+> View all available icons at https://wso2.github.io/oxygen-ui/react/?path=/docs/icons-icons-%F0%9F%9A%A7--page.
+
 Each icon component accepts the following props:
 
 - `aria-label`: The aria label to be used for the icon.