@adyen/kyc-components 2.11.0 → 2.12.0

package/README.md

@@ -1,11 +1,8 @@
 [![Test CI](https://github.com/Adyen/adyen-kyc-components/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/Adyen/adyen-kyc-components/actions/workflows/main.yml) [![End-to-End Tests](https://github.com/Adyen/adyen-kyc-components/actions/workflows/e2e-test.yml/badge.svg)](https://github.com/Adyen/adyen-kyc-components/actions/workflows/e2e-test.yml)
 
-# Adyen KYC Monorepo
+# Adyen KYC Components
 
-## KYC components
-
-Adyen Kyc-components provides the required forms/elements/dropins to build up an onboarding flow based
-on a legalentity.
+`adyen-kyc-components` provides the required pieces to build an onboarding flow based on a legal entity.
 
 ## Setup
 
@@ -46,9 +43,9 @@ on a legalentity.
    form.mount('#container');
    ```
 
-Configurations based on a country are underway, each form component will be capable of take
-in a country as prop based on which it will be rendered. If no country is provided the country
-value provided at initialization step will be used to configure.
+Configurations based on a country are underway, each form component will be capable of taking
+in a country as a prop, based on which it will be rendered. If no country is provided the country
+value provided during initialization will be used.
 
 ## Configuration
 
@@ -78,7 +75,6 @@ Possible values are:
 
 | Option                    | Required  | Type                                                                                                                                                                               | Remarks                                                                                                                                                                                                                                                                                                                               |
 | ------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `isReview`                | Optional  | _boolean_                                                                                                                                                                          | Change all forms to be in review mode, essentially starting (and ending) every flow with a summary screen, with buttons changed to confirm and review.                                                                                                                                                                                |
 | `legalEntityResponse`     | Required  | Legal Entity _object_ that is returned from the [Legal Entities API](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/get/legalEntities/{id})                              | this now contains extended properties, see [legal-entity.ts](https://github.com/Adyen/adyen-kyc-components/blob/main/packages/lib/src/core/models/api/legal-entity.ts) for more details                                                                                                                                               |
 | `capabilities`            | Required  | _array_                                                                                                                                                                            | List of capabilities that are being requested, e.g. ['PSP_PAYOUT']                                                                                                                                                                                                                                                                    |
 | `readOnly`                | Rrequired | _boolean_                                                                                                                                                                          | to set form to read only mode                                                                                                                                                                                                                                                                                                         |
@@ -161,3 +157,7 @@ To use it, first download the report artifact for the given test run from GitHub
 
 [Static assets](./assets) are compiled and shipped separately to kycexternalapi every time a new asset is added or changed.
 For more information see the [documentation for static assets](./assets/README.md).
+
+## Contributing
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to standardize our commit messages and validate this in our CI. [More reading.](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)