@bigbinary/neeto-form-frontend 1.0.10 → 1.0.12

package/README.md

@@ -23,6 +23,21 @@ Import stylesheet from the following location:
 @import "@bigbinary/neeto-form-frontend/dist/main.css";
 ```
 
+This package relies on the host project's tailwind configuration. So add
+neeto-form-frontend to your project's tailwind.config.js file:
+
+```js
+module.exports = {
+  purge: {
+    content: [
+      // ... other content directories
+      "./node_modules/@bigbinary/neeto-form-frontend/**/*.js",
+    ],
+  },
+  // ... other tailwind config options
+};
+```
+
 Add `NeetoFormProvider` to the root of your application:
 
 ```jsx
@@ -87,6 +102,8 @@ import { ExternalForm } from "@bigbinary/neeto-form-frontend";
 | `clearValuesOnSubmit` | `boolean`         | To clear local storage values on submit                                |
 | `clearValuesOnReset`  | `boolean`         | To clear local storage values on reset                                 |
 | `formDomProps`        | `object`          | To set props for form element                                          |
+| `initialValues`       | `object`          | To set initial values for form                                         |
+| `onChange`            | `function`        | Callback for form field values change                                  |
 
 `Submission` component is used to render a form result.
 
@@ -167,11 +184,27 @@ Then run the below command on the host application root directory
 yalc add @bigbinary/neeto-form-frontend
 ```
 
-## Building
-
-The neetoFormEngine-frontend package gets auto-published to npm for every new
-merge to the main branch. You can checkout the `publish` workflow in git actions
-to get a live update.
+# Building and releasing.
+
+The `@bigbinary/neeto-form-frontend` 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-form-frontend/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
 
 ## Used in