Update README.md

Author: piyushlathiya

README.md

@@ -1,17 +1,14 @@
-# Vue Storefront Google Recaptcha module
-[Google Recaptcha](https://developers.google.com/recaptcha) integration for [vue-storefront](https://github.com/aureatelabs/vsf-google-recaptcha), by [Aureate Labs Pvt. Ltd.](https://aureatelabs.com/).
-<br />Google Recaptcha registration required (It's a free)
-<br /><br />
-Google recaptcha is for the protect the spamming your any submiting form and idea about to do some other stuff authentication to prevent this.
-<br /><br />
-![Demo](docs/preview.png)
-<br/>
+# Vue Storefront Google Invisible reCAPTCHA extension
+[Google Invisible reCAPTCHA v3](https://developers.google.com/recaptcha) integration for [vue-storefront](https://github.com/aureatelabs/vsf-google-recaptcha), by [Aureate Labs](https://aureatelabs.com/)
+> This extension helps to prevent bot form submission using Google reCAPTCHA service
+
+**Note:** Google reCAPTCHA registration required (It's a free) to use this extension into your vue-storefront website.
 
-Google recaptcha module for Vue Storefront️
+Google reCAPTCHA is for the protect the spamming your any submiting form and idea about to do some other stuff authentication to prevent this.
 
-> Google recaptcha documentation: https://developers.google.com/recaptcha/intro
+![Demo](docs/preview.png)
 
-<br/>
+Google reCAPTCHA documentation: https://developers.google.com/recaptcha/intro
 
 ## Installation:
 
@@ -21,8 +18,7 @@ Clone the vsf-google-recaptcha repository into your VSF installation.
 ```shell
 $ git clone git@github.com:aureatelabs/vsf-google-recaptcha.git vue-storefront/src/modules/google-recaptcha
 ```
-
-### 2. Add the module config to your local VSF configuration file.
+### 2. Add the extension config to your local VSF configuration file.
 Add the following JSON config snippet into your desired config, eg. `config/local.json`
 ```json
 "googleRecaptcha" : {
@@ -33,15 +29,12 @@ Add the following JSON config snippet into your desired config, eg. `config/loca
    "is_active": false
 }
 ```
-Replace the `site_key` & `secret_key` parameter with the site key & secret key provided by Google recaptcha registration time. You can find your Captcha Site Key here: https://www.google.com/recaptcha/admin/. Setting `is_active` to `false` will disable the google recaptcha module at runtime.
-<br />
+Replace the `site_key` & `secret_key` parameter with the site key & secret key provided by Google reCAPTCHA registration time. You can find your Captcha Site Key here: https://www.google.com/recaptcha/admin/. Setting `is_active` to `false` will disable the google reCAPTCHA extension at runtime.
+
 Valid site_key example: `"site_key": "6Lcn_Z0UAAAAAN4LdRSfM5eNd3LJ-xPfUtnV6Lud"`
-<br />
 Valid secret_key example: `"secret_key": "6Lcn_Z0UAAAAACodWP8oU9wcdVKatvQVBqklWA9c"`
-
-### 3. Register the Google Recaptcha module
-Open up your `../vue-storefront/src/modules/index.ts` and add the following code. Adding it inside this file the registers the module so it can be used in your Vue Storefront.
-<br />
+### 3. Register the Google reCAPTCHA extension
+Open up your `../vue-storefront/src/modules/index.ts` and add the following code. Adding it inside this file the registers the extension so it can be used in your Vue Storefront.
 ```js
 import { GoogleRecaptcha } from './google-recaptcha'
 ...
@@ -51,25 +44,22 @@ GoogleRecaptcha
 ...
 ]
 ```
-
 ### 4. How to call captcha method
 In your theme template file you can directly call store action and immediate next you can check captcha is verified or not
-<br />
 ```js
 this.$store.dispatch('googleRecaptcha/isVerifiedCaptcha')
 if (!this.$store.state.googleRecaptcha.is_verified) {
     //captcha is not verified
 }
 ```
 
-### 5. Now, Clone google Recaptcha API extension to your local vue-storefront-api
+### 5. Now, Clone google reCAPTCHA API extension to your local vue-storefront-api
 Copy extension to your /path/to/vue-storefront-api/src/api/extensions/
-<br />
 ```shell
 $ cp -f ./API/google-recaptcha /path/to/vue-storefront-api/src/api/extensions/
 ```
 
-### 6. Add the module config to your local VSF API's configuration file
+### 6. Add the extension config to your local VSF API's configuration file
 Add the following JSON config snippet into your desired config, eg. `config/local.json`
 ```json
 "googleRecaptcha" : {
@@ -82,11 +72,11 @@ Add the following JSON config snippet into your desired config, eg. `config/loca
   }
 }
 ```
-Replace the `secret_key` parameter with the secret key provided by Google recaptcha registration time. You can find your Captcha Site Key here: https://www.google.com/recaptcha/admin/. Setting `enable` to `true` will check the captcha base on the score response from the google captcha api. To disable score match simple set value to `false`. Possible values for `low_score` is `0.0` to `0.9`.
-<br />
+Replace the `secret_key` parameter with the secret key provided by Google reCAPTCHA registration time. You can find your Captcha Site Key here: https://www.google.com/recaptcha/admin/. Setting `enable` to `true` will check the captcha base on the score response from the google captcha api. To disable score match simple set value to `false`. Possible values for `low_score` is `0.0` to `0.9`.
+
 Valid secret_key example: `"secret_key": "6Lcn_Z0UAAAAACodWP8oU9wcdVKatvQVBqklWA9c"`
-<br />
-sample response of api call `/api/ext/google-recaptcha/is-verify`
+
+Sample response of api call `/api/ext/google-recaptcha/is-verify`
 ```
 { success: false, error: 'Invalid captcha found.' }
 ```
@@ -95,11 +85,9 @@ sample response of api call `/api/ext/google-recaptcha/is-verify`
 Thats it! It's easy, plug and play! If you haven't got an Register captcha already, you can create one here, there is free tier that you can use to get started: https://www.google.com/recaptcha/admin/create
 
 ## Customization
-### Replacing the Google captcha Script.
-If you need to change the Intercom script that is loaded on the page, open up the `./google-recaptcha/hooks/afterRegistration.ts` file. On line 35 you'll find the script provided from Google Recaptcha, you can swap this out or extend it as required.
 
+### Replacing the Google captcha Script.
+If you need to change the Intercom script that is loaded on the page, open up the `./google-recaptcha/hooks/afterRegistration.ts` file. On line 35 you'll find the script provided from Google reCAPTCHA, you can swap this out or extend it as required.
 
 ## License
-
-<br/>
-This project is licensed under the MIT License.
+This project is licensed under the [MIT License](https://github.com/aureatelabs/vsf-google-recaptcha/blob/master/LICENSE)