1
1
# neetoIcons
2
2
3
- The neetoIcons library is a collection of SVG React component icons that drives
3
+ The neetoIcons and neetoIconsRN library are a collection of SVG React component icons that drives
4
4
the experience in the neeto products built at BigBinary.
5
5
6
6
### Installation
7
7
8
+ Web:
9
+
8
10
```
9
11
yarn add @bigbinary/neeto-icons
10
12
```
11
13
14
+ React Native:
15
+
16
+ ```
17
+ yarn add @bigbinary/neeto-icons-rn
18
+ ```
19
+
20
+
12
21
### Usage
13
22
23
+ Web:
24
+
14
25
``` javascript
15
26
import { Clock } from " @bigbinary/neeto-icons" ;
16
27
```
17
28
29
+ React Native:
30
+
31
+ ``` javascript
32
+ import { Icons } from " @bigbinary/neeto-icons-rn" ;
33
+ import { AppIcons } from " @bigbinary/neeto-icons-rn" ;
34
+ import { Logos } from " @bigbinary/neeto-icons-rn" ;
35
+ import { Misc as MiscIcons } from " @bigbinary/neeto-icons-rn" ;
36
+ import { TypefaceLogos } from " @bigbinary/neeto-icons-rn" ;
37
+
38
+ const { Archive } = Icons;
39
+ ```
40
+
18
41
Anywhere in your React file
19
42
20
43
``` jsx
@@ -85,7 +108,7 @@ Anywhere in your React file
85
108
86
109
# Building and releasing.
87
110
88
- The ` @bigbinary/neeto-icons ` package gets published to NPM when we merge a PR
111
+ The ` @bigbinary/neeto-icons ` and ` @bigbinary/neeto-icons-rn ` package gets published to NPM when we merge a PR
89
112
with ` patch ` , ` minor ` or ` major ` label to the ` main ` branch. The ` patch ` label
90
113
is used for bug fixes, ` minor ` label is used for new features and ` major ` label
91
114
is used for breaking changes. You can checkout the ` Create and publish releases `
@@ -101,6 +124,6 @@ github actions will automatically publish the built package to npm. You can
101
124
checkout the ` Publish to npm ` workflow in GitHub Actions to get a live update.
102
125
103
126
Please note that before publishing the package, you need to verify the
104
- functionality in some of the neeto web- apps locally using ` yalc ` package
127
+ functionality in some of the neeto web and mobile apps locally using ` yalc ` package
105
128
manager. The usage of yalc is explained in this video:
106
129
https://youtu.be/QBiYGP0Rhe0
0 commit comments