@bigbinary/neeto-approvals-frontend 0.0.2

package/README.md

@@ -0,0 +1,43 @@
+# @bigbinary/neeto-approvals-frontend
+
+neetoApprovals is a library that manages approvals across neeto products.
+
+## Installation
+
+1. **neetoApprovals** has a few peer dependencies that are required for the proper
+functioning of the package. Install all the peer dependencies using the below
+command:
+
+    ```zsh
+    yarn add @bigbinary/neeto-icons@1.8.46 @bigbinary/neetoui@4.1.33 axios@1.2.1 classnames@2.3.2 formik@2.2.9 ramda@0.28.0 react-router-dom@5.3.3 react-toastify@8.2.0 react-query@3.39.2 yup@0.32.11
+    ```
+
+2. Now install the latest **neetoApprovals** package using the below command:
+
+    ```zsh
+    yarn add @bigbinary/neeto-approvals-frontend
+    ```
+
+## Usage
+WIP
+
+## Development
+
+1. Install all the dependencies by executing the following command
+
+    ```zsh
+    yarn install
+    ```
+
+2. See the changes in the example app by executing the following command:
+
+    ```zsh
+    yarn dev
+    ```
+
+## Building
+
+The neetoApprovals package gets published to NPM only when we add the `release` label to the PR.
+By default the `release` label will bump the patch version. If you want to release a minor or major version,
+then along with the `release` label, add the `minor` or `major` label as well.
+You can checkout the `publish` workflow in GitHub Actions to get a live update.