Update for M2.4.4 and PHP8.1

aitoc · Apr 29, 2022 · 930061f · 930061f
1 parent 133550e
commit 930061f
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,109 @@
-# magento-clarity
-Magento 2 integration with Microsoft Clarity
+# [Microsoft Clarity for Magento](https://www.aitoc.com/microsoft-clarity.html)
+
+## Description
+
+[**Microsoft Clarity**](https://clarity.microsoft.com/) is an analytics tool that provides website usage statistics, session recording, and heatmaps. It is a free user behavior analytics tool that helps you understand how users interact with your website through session replays and heatmaps. It records the information about your website's visitors, tracks how users behave, and provide you with analytical data.
+
+## Use of Microsoft Clarity module tool on the website
+
+Because of our module, no code changes are required, or no need to manually add any script. By only adding tracking code from the Microsoft Clarity account, the Microsoft Clarity tool will get enabled on the website.
+
+## Key Features
+
+- The easiest way to enable the Microsoft Clarity tool
+- No code changes are required to configure and start using Microsoft Clarity integration
+- Session Recordings to see precisely how your site is being used
+- Show Heatmaps and Clickmaps, which tell what users want and how you can play around with the design to get more attention from the user on specific things
+- Multiple filter options to dig through user behavior and find accurate details
+
+## Useful Information
+
+- [**About Us**](https://www.aitoc.com/about-us.html) 
+- [**Privacy Policy**](https://www.aitoc.com/privacy-policy.html)  
+- [**Partnership Program**](https://www.aitoc.com/partnership-program)  
+- [**Affiliate Program**](https://www.aitoc.com/affiliate-program)  
+- [**Aitoc Customer Rewards**](https://www.aitoc.com/reward-points)  
+- [**Microsoft Clarity User Guide**](https://www.aitoc.com/docs/microsoft-clarity/)  
+- [**Get Support**](https://www.aitoc.com/get-support.html)  
+
+## Installation Guide
+
+### Installing module using zip file
+
+- Unzip and paste the extension file into your root Magento folder.
+- Connect to your server by SSH.
+- Go to your Magento root folder.
+- To install the extension, perform this command:
+
+```
+php bin/magento setup:upgrade
+php bin/magento setup:di:compile
+php bin/magento setup:static-content:deploy
+```
+
+### Composer installation
+
+If you haven't installed any Aitoc module before, in that case, first, you  will need to add your Aitoc composer repository. Please go through the [document](https://www.aitoc.com/docs/composer#extensions-installation-via-composer) to see how you can add a composer repository.
+
+To install the module, you will need to run the following commands:
+
+```
+composer require aitoc/module-microsoft-clarity
+php bin/magento setup:upgrade
+php bin/magento setup:di:compile
+php bin/magento setup:static-content:deploy -f
+```
+
+- To switch the extension on/off, perform these commands:
+
+```
+php bin/magento module:enable Aitoc_MicrosoftClarity
+php bin/magento module:disable Aitoc_MicrosoftClarity
+```
+
+## Microsoft Clarity Tracking Code
+
+Once you have created a new project in [**Microsoft Clarity**](https://clarity.microsoft.com/), from your Project Dashboard, select the **Setup** tab. In the Setup tab, you will find the **Clarity tracking code**, and below that the script will be available.
+
+We only need the tracking code to configure and enable Microsoft Clarity on your Magento website from the script.
+[![](docs/trackingcode.png)](docs/trackingcode.png)
+
+## Configuration
+
+Path: **Stores → Configuration → AITOC EXTENSION → Microsoft Clarity** Or **Admin → AITOC → Microsoft Clarity → Configuration**
+
+[![](docs/config.png)](docs/config.png)
+
+**Enabled:** _Yes/No_ - Sets whether the module is enabled or disabled. 
+**Tracking Code:** _Text_ - Please enter your Microsoft Clarity tracking code here.
+**Enable Customer Group Tag** - If this is enabled, custom tags and filters will be created based on the Customer Groups available in Magento in Microsoft Clarity. So for each session and page that are tracked in Clarity, they will have a Customer Group tag, so it will be easier to filter and find session/recording for each page based on customer group.
+
+## How the module works
+
+Once you have added the **Tracking Code**, the Microsoft Clarity Script will start to appear on the front end of each page. You can view this in Page Source or your browser's developer tools.
+
+[![](docs/console.png)](docs/console.png)
+
+Also, in your [Microsoft Clarity](https://clarity.microsoft.com/) Account, under the project you have created, you will start to see analytics details based on visitors' activity on your site. You can see this in:
+
+Log in to Your Microsoft Clarity Account, → Select your Project → Dashboard & Recording
+
+[![](docs/dashboard.png)](docs/dashboard.png)
+
+## More FREE Magento 2 Extensions by Aitoc on GitHub
+
+- [**Google Customer Review**](https://github.com/aitoc/magento-2-google-customer-reviews) 
+- [**SMTP**](https://github.com/aitoc/magento-2-smtp)  
+
+## Other Magento 2 Extensions by Aitoc
+
+- [**Save My Cart**](https://www.aitoc.com/save-my-cart.html) 
+- [**No Password Login**](https://www.aitoc.com/no-password-login.html)  
+- [**Invoice Payment**](https://www.aitoc.com/invoice-payment.html)  
+- [**Order Export and Import**](https://www.aitoc.com/magento-2-orders-export-and-import.html)  
+- [**Custom Product Designer**](https://www.aitoc.com/magento-2-custom-product-designer.html)  
+- [**Advanced Permission**](https://www.aitoc.com/magento-2-advanced-permissions.html)
+
+See more [**Magento 2 extensions**](https://www.aitoc.com/magento-2-extensions.html)
+
+THANKS FOR CHOOSING AITOC 
diff --git a/composer.json b/composer.json
@@ -1,14 +1,14 @@
 {
   "name": "aitoc/module-microsoft-clarity",
-  "description": "Module that enables your site integrate with Microsoft's Clarity, a web analytics/behaviour monitoring platform",
+  "description": "Module that enables your site to integrate with Microsoft's Clarity, a web analytics/behaviour monitoring platform",
   "require": {
-    "php": "~5.6.5|7.0.2|7.0.4|~7.0.6|~7.0.13|~7.1.0|~7.2.0|~7.3.0|~7.4.0",
+    "php": "~5.6.5|7.0.2|7.0.4|~7.0.6|~7.0.13|~7.1.0|~7.2.0|~7.3.0|~7.4.0|~8.0.0|~8.1.0",
     "aitoc/core": ">=1.0.8"
   },
   "type": "magento2-module",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": [
-    "proprietary"
+    "MIT"
   ],
   "autoload": {
     "files": [

diff --git a/docs/config.png b/docs/config.png
diff --git a/docs/console.png b/docs/console.png
diff --git a/docs/dashboard.png b/docs/dashboard.png
diff --git a/docs/trackingcode.png b/docs/trackingcode.png