@bigbinary/neeto-icons 1.17.9 → 1.17.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/.vscode/settings.json +3 -0
- package/README.md +11 -32
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,13 @@
|
|
|
3
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
|
+
## Contents
|
|
7
|
+
- [Installation](#installation)
|
|
8
|
+
- [Usage](#usage)
|
|
9
|
+
- [How it works](#how-it-works)
|
|
10
|
+
- [Instructions for publishing](#instructions-for-publishing)
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
7
13
|
|
|
8
14
|
Web:
|
|
9
15
|
|
|
@@ -17,7 +23,7 @@ React Native:
|
|
|
17
23
|
yarn add @bigbinary/neeto-icons-rn
|
|
18
24
|
```
|
|
19
25
|
|
|
20
|
-
|
|
26
|
+
## Usage
|
|
21
27
|
|
|
22
28
|
Web:
|
|
23
29
|
|
|
@@ -81,7 +87,7 @@ Anywhere in your React file
|
|
|
81
87
|
| width | string, number | auto | Value supplied to width attribute of SVG element. |
|
|
82
88
|
| className | string | | Classes supplied to the SVG element. |
|
|
83
89
|
|
|
84
|
-
|
|
90
|
+
## How it works
|
|
85
91
|
|
|
86
92
|
- We use a custom rollup plugin (which can be found in `build/index.mjs`) to
|
|
87
93
|
take all the `.svg` files from the `source` folder and convert them to React
|
|
@@ -99,33 +105,6 @@ Anywhere in your React file
|
|
|
99
105
|
- For each icon, a React icon file will be generated in `generate/icons` folder.
|
|
100
106
|
- From there babel through rollup takes the wheel and generates the bundles.
|
|
101
107
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
The `@bigbinary/neeto-icons` and `@bigbinary/neeto-icons-rn` package gets published to NPM when we merge a PR
|
|
105
|
-
with `patch`, `minor` or `major` label to the `main` branch.
|
|
106
|
-
|
|
107
|
-
- `patch` label is used for bug fixes and new icons
|
|
108
|
-
- `minor` label is used for new features
|
|
109
|
-
- `major` label is used for breaking changes
|
|
110
|
-
|
|
111
|
-
You can checkout the `Create and publish releases` workflow in GitHub Actions to get a live update.
|
|
112
|
-
|
|
113
|
-
In case if you missed to add the label, you can manually publish the package.
|
|
114
|
-
For that first you need to create a PR to update the version number in the
|
|
115
|
-
`package.json` file and merge it to the `main` branch. After merging the PR, you
|
|
116
|
-
need to create a
|
|
117
|
-
[new github release](https://github.com/bigbinary/neeto-icons/releases/new) from
|
|
118
|
-
main branch. Whenever a new release is created with a new version number, the
|
|
119
|
-
github actions will automatically publish the built package to npm. You can
|
|
120
|
-
checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
|
|
121
|
-
|
|
122
|
-
Please note that before publishing the package, you need to verify the
|
|
123
|
-
functionality in some of the neeto web and mobile apps locally using `yalc` package
|
|
124
|
-
manager. The usage of yalc is explained in this video:
|
|
125
|
-
https://youtu.be/QBiYGP0Rhe0
|
|
126
|
-
|
|
127
|
-
### Steps to release
|
|
108
|
+
## Instructions for Publishing
|
|
128
109
|
|
|
129
|
-
|
|
130
|
-
- Create a Pull Request (PR)
|
|
131
|
-
- Assign the required label and merge the PR to main
|
|
110
|
+
Consult the [building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide for details on how to publish.
|