docs: update README.md

kodingdotninja · Feb 2, 2022 · 44ca763 · 44ca763
1 parent 95ffd7a
commit 44ca763
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -11,12 +11,13 @@
 
 ## Packages
 
-| Name                                                                                                         | Publishable | Version                                                                                                               |
-| ------------------------------------------------------------------------------------------------------------ | ----------- | --------------------------------------------------------------------------------------------------------------------- |
-| [create-chakra-icons](https://github.com/kodingdotninja/chakra-icons/tree/main/packages/create-chakra-icons) | ✅          | [![npm version](https://badge.fury.io/js/create-chakra-icons.svg)](https://www.npmjs.com/package/create-chakra-icons) |
-| [@chakra-icons/cli](https://github.com/kodingdotninja/chakra-icons/tree/main/tooling/cli)                    | ✅          | [![npm version](https://badge.fury.io/js/@chakra-icons/cli.svg)](https://www.npmjs.com/package/@chakra-icons/cli)     |
-| [@tooling/tsconfig](https://github.com/kodingdotninja/chakra-icons/tree/main/tooling/ts.conf)                | ❌          |                                                                                                                       |
-| [@tooling/msrconfig](https://github.com/kodingdotninja/chakra-icons/tree/main/tooling/msr.conf)              | ❌          |                                                                                                                       |
+| Name                                                                                                                 | Publishable | Version                                                                                                                         |
+| -------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| [create-chakra-icons](https://github.com/kodingdotninja/chakra-icons/tree/main/packages/create-chakra-icons)         | ✅          | [![npm version](https://badge.fury.io/js/create-chakra-icons.svg)](https://www.npmjs.com/package/create-chakra-icons)           |
+| [@chakra-icons/bootstrap](https://github.com/kodingdotninja/chakra-icons/tree/main/packages/@chakra-icons/bootstrap) | ✅          | [![npm version](https://badge.fury.io/js/@chakra-icons%2Fbootstrap.svg)](https://www.npmjs.com/package/@chakra-icons/bootstrap) |
+| [@chakra-icons/cli](https://github.com/kodingdotninja/chakra-icons/tree/main/tooling/cli)                            | ✅          | [![npm version](https://badge.fury.io/js/@chakra-icons%2Fcli.svg)](https://www.npmjs.com/package/@chakra-icons/cli)             |
+| [@tooling/tsconfig](https://github.com/kodingdotninja/chakra-icons/tree/main/tooling/ts.conf)                        | ❌          |                                                                                                                                 |
+| [@tooling/msrconfig](https://github.com/kodingdotninja/chakra-icons/tree/main/tooling/msr.conf)                      | ❌          |                                                                                                                                 |
 
 ## Contribution
 

diff --git a/packages/@chakra-icons/bootstrap/README.md b/packages/@chakra-icons/bootstrap/README.md
@@ -0,0 +1,26 @@
+## How To
+
+### Installation
+
+```console
+yarn add @chakra-icons/bootstrap
+```
+
+**OR use NPM**
+
+```console
+npm install --save-dev @chakra-icons/bootstrap
+```
+
+### Usage
+
+```jsx
+import { IconName } from "@chakra-icons/bootstrap";
+const App = () => (
+  <div>
+    <IconName boxSize="md" color="blue" />
+  </div>
+);
+```
+
+You just need to change `IconName` with the specific icon name that we are provided, See [List Available Icons](https://github.com/kodingdotninja/chakra-icons/tree/main/packages/@chakra-icons/bootstrap/snapshot.json).