@esmalley/react-material-icons 3.0.5 → 3.0.6

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 +1,45 @@
1
- # react-material-icons
1
+ # react-material-icons
2
+
3
+ ## Using this lib
4
+ ```sh
5
+ npm install @esmalley/react-material-icons
6
+ ```
7
+
8
+ ```jsx
9
+ import Abc from '@esmalley/react-material-icons/Abc';
10
+
11
+ return (
12
+ <>
13
+ <Abc />
14
+ </>
15
+ );
16
+ ```
17
+
18
+ ### Pass standard dom props
19
+ ```jsx
20
+ import Abc from '@esmalley/react-material-icons/Abc';
21
+
22
+ return (
23
+ <>
24
+ <Abc style = {{ fontSize: 30, color: 'red', margin: 5 }} onClick = {() => console.log('hi')} />
25
+ </>
26
+ )
27
+ ```
28
+
29
+
30
+ ## Working on this lib
31
+
32
+ ```sh
33
+ npm run build
34
+ ```
35
+
36
+ This will run `bash build.sh`, do a bunch of clean up then `node build.mjs`
37
+
38
+ #### build.sh
39
+ This file will copy the svg icons from `@material-design-icons/svg`. Create the react icon tsx wrapper, then create them all as react components, rename, etc.
40
+
41
+ ### Publish to npm
42
+ ```sh
43
+ git tag v3.2.1
44
+ git push origin v3.2.1
45
+ ```