@bigbinary/neetoui 4.4.18 → 4.4.19

package/README.md

@@ -62,9 +62,27 @@ Running the `yarn storybook` command starts a storybook app. Use this applicatio
 
 Note that nothing in the `stories` folder will be bundled with **neetoUI**.
 
-## Building
-
-neetoUI gets auto-published to npm on new commit to main. You can checkout the `publish` workflow in git actions to get a live update.
+# Building and releasing.
+
+The `@bigbinary/neetoui` package gets published to NPM when we
+merge a PR with `patch`, `minor` or `major` label to the `main` branch. The
+`patch` label is used for bug fixes, `minor` label is used for new features and
+`major` label is used for breaking changes. You can checkout the
+`Create and publish releases` workflow in GitHub Actions to get a live update.
+
+In case if you missed to add the label, you can manually publish the package.
+For that first you need to create a PR to update the version number in the
+`package.json` file and merge it to the `main` branch. After merging the PR, you
+need to create a
+[new github release](https://github.com/bigbinary/neeto-ui/releases/new)
+from main branch. Whenever a new release is created with a new version number,
+the github actions will automatically publish the built package to npm. You can
+checkout the `Publish to npm` workflow in GitHub Actions to get a live update.
+
+Please note that before publishing the package, you need to verify the
+functionality in some of the neeto web-apps locally using `yalc` package
+manager. The usage of yalc is explained in this video:
+https://youtu.be/QBiYGP0Rhe0
 
 ## Documentation