@bigbinary/neeto-icons 1.14.0 → 1.16.0
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 +22 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,39 @@
|
|
|
1
1
|
# neetoIcons
|
|
2
2
|
|
|
3
|
-
The neetoIcons library
|
|
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 { Clock } from "@bigbinary/neeto-icons-rn";
|
|
33
|
+
|
|
34
|
+
const { Archive } = Icons;
|
|
35
|
+
```
|
|
36
|
+
|
|
18
37
|
Anywhere in your React file
|
|
19
38
|
|
|
20
39
|
```jsx
|
|
@@ -85,7 +104,7 @@ Anywhere in your React file
|
|
|
85
104
|
|
|
86
105
|
# Building and releasing.
|
|
87
106
|
|
|
88
|
-
The `@bigbinary/neeto-icons` package gets published to NPM when we merge a PR
|
|
107
|
+
The `@bigbinary/neeto-icons` and `@bigbinary/neeto-icons-rn` package gets published to NPM when we merge a PR
|
|
89
108
|
with `patch`, `minor` or `major` label to the `main` branch. The `patch` label
|
|
90
109
|
is used for bug fixes, `minor` label is used for new features and `major` label
|
|
91
110
|
is used for breaking changes. You can checkout the `Create and publish releases`
|
|
@@ -101,6 +120,6 @@ github actions will automatically publish the built package to npm. You can
|
|
|
101
120
|
checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
|
|
102
121
|
|
|
103
122
|
Please note that before publishing the package, you need to verify the
|
|
104
|
-
functionality in some of the neeto web
|
|
123
|
+
functionality in some of the neeto web and mobile apps locally using `yalc` package
|
|
105
124
|
manager. The usage of yalc is explained in this video:
|
|
106
125
|
https://youtu.be/QBiYGP0Rhe0
|