metal-icons 0.1.9 → 0.1.11

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 CHANGED
@@ -1,19 +1,30 @@
1
1
  # Metal Icons
2
2
 
3
- v0.1.9
4
-
5
3
  A flexible set of icons built for React.
6
4
 
7
- ## Goals
5
+ ---
6
+
7
+ ## Basic Usage
8
+
9
+ All icons are available as individual React components.
8
10
 
9
- - Design an icon set with two base sizes: 16px and 24px, providing an outline and a solid version of each.
10
- - Build a easy-to-use JavaScript icon library for React projects.
11
+ First, install `metal-icons` from npm:
11
12
 
12
- ## Figma Community
13
+ ```bash
14
+ yarn add metal-icons
15
+ ```
13
16
 
14
- [Metal Icons](https://www.figma.com/community/file/1275692756020345515/Metal-Icons)
17
+ Now, you can import each icon individually as a React component:
15
18
 
16
- ## Inspiration
19
+ ```JavaScript
20
+ import { Folder } from 'metal-icons'
17
21
 
18
- - [Heroicons](https://heroicons.com/)
19
- - [Feather](https://feathericons.com/)
22
+ function Button() {
23
+ return (
24
+ <button>
25
+ <Folder />
26
+ <span>Add Folder</span>
27
+ </button>
28
+ )
29
+ }
30
+ ```