@koobiq/react-icons 0.0.1-beta.1 → 0.0.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,32 @@
|
|
|
1
1
|
# @koobiq/react-icons
|
|
2
|
+
|
|
3
|
+
A collection of React-icons for the web, part of Koobiq React.
|
|
4
|
+
|
|
5
|
+
## Showcase
|
|
6
|
+
|
|
7
|
+
Use the [icon showcase](https://react.koobiq.io/?path=/docs/icons--docs) to visually present the package contents.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
Depending on your preference, run one of the following in your terminal:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
# With npm
|
|
15
|
+
npm install @koobiq/react-icons
|
|
16
|
+
|
|
17
|
+
# With yarn
|
|
18
|
+
yarn add @koobiq/react-icons
|
|
19
|
+
|
|
20
|
+
# With pnpm
|
|
21
|
+
yarn add @koobiq/react-icons
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
Import the required icon from the package:
|
|
27
|
+
|
|
28
|
+
```jsx
|
|
29
|
+
import { IconCheck16 } from '@koobiq/react-icons';
|
|
30
|
+
|
|
31
|
+
const SuccessIcon = () => <IconCheck16 color="#4CAF50" />;
|
|
32
|
+
```
|