metal-icons 0.2.0 → 0.2.1
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/.gitignore +1 -0
- package/README.md +36 -0
- package/package.json +1 -1
package/.gitignore
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Metal Icons
|
|
2
|
+
|
|
3
|
+
A flexible set of icons built for React.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Basic Usage
|
|
8
|
+
|
|
9
|
+
All icons are available as individual React components.
|
|
10
|
+
|
|
11
|
+
First, install `metal-icons` from npm:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
yarn add metal-icons
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Now, you can import each icon individually as a React component:
|
|
18
|
+
|
|
19
|
+
```javascript
|
|
20
|
+
import { FolderIcon } from `metal-icons/16/solid`
|
|
21
|
+
|
|
22
|
+
export default function MyComponent() {
|
|
23
|
+
return (
|
|
24
|
+
<button>
|
|
25
|
+
<FolderIcon />
|
|
26
|
+
Add Folder
|
|
27
|
+
</button>
|
|
28
|
+
)
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Icons follow an `UpperCamelCase` naming convention and always end with the word "Icon."
|
|
33
|
+
|
|
34
|
+
## License
|
|
35
|
+
|
|
36
|
+
Licensed under the MIT License, Copyright © 2023-present Jason Melgoza.
|