Skip to content

Commit 3a7a1f8

Browse files
committed
Adjust documentation
1 parent acc5245 commit 3a7a1f8

6 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
4747
***
4848

4949
* [Overview](#overview)
50-
* [Installation](#installation)
51-
* [Testing](#testing)
50+
* [Important documents](#important-documents)
5251
* [Functionalities](#functionalities)
5352
* [Demo](#demo)
5453
* [License](#license)
@@ -58,8 +57,7 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
5857
# Overview
5958

6059
----
61-
The **SyliusUserComPlugin** allows you to integrate your Sylius store with the User.com platform. User.com is a platform that allows you to automate your marketing, sales, and support processes. With this plugin, you can synchronize your Sylius store with User.com and use the data collected in your store to create personalized marketing campaigns, automate sales processes, and provide better customer support.
62-
60+
The **SyliusUserComPlugin** is designed to seamlessly integrate User.com with any Sylius platform app, enabling businesses to monitor customer activity, synchronize agreements, and track orders effortlessly. This plugin acts as a bridge between Sylius and User.com, ensuring businesses gain valuable behavioral insights while enhancing user engagement and retention.
6361
# Important documents
6462

6563
---

config/packages/messenger.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ framework:
22
messenger:
33
transports:
44
user_com_asynchronous:
5-
dsn: "%env(MESSENGER_USER_COM_ASYNCHRONOUS)%"
5+
dsn: "%env(MESSENGER_USER_COM_ASYNCHRONOUS_DSN)%"
66
retry_strategy:
77
max_retries: 5
88
#1000 * 60 * 10

doc/functionalities.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ The **BitBagSyliusUserComPlugin** integrates **User.com** with Sylius-based stor
2929
### 6. Tag Manager Script Injection
3030
- Allows users to **inject custom scripts** via **Tag Manager**.
3131
- Enables integration with **third-party tracking tools**.
32+
33+
### 7. User information object
34+
- you can use `user_com_customer_info` in browser console to check currently logged in customer data

doc/installation.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
GOOGLE_ANALYTICS_TAG=""
1010
USER_COM_ENCRYPTION_KEY=your-32-character-long-key
1111
USER_COM_ENCRYPTION_IV=your-16-character-long-iv
12-
MESSENGER_USER_COM_ASYNCHRONOUS=""
12+
MESSENGER_USER_COM_ASYNCHRONOUS_DSN=""
1313
```
1414
3. Add plugin dependencies to `config/bundles.php` file. Make sure that none of the bundles are duplicated.
1515
```php
@@ -33,13 +33,13 @@
3333
...
3434
```
3535
36-
4. Import routes in your `config/routes.yaml` file:
36+
5. Import routes in your `config/routes.yaml` file:
3737
```yaml
3838
bitbag_sylius_user_com_plugin:
3939
resource: "@BitBagSyliusUserComPlugin/config/routes.yaml"
4040
```
4141
42-
5. Extend `Channel` entity `UserComApiAwareTrait` and implement `UserComApiAwareInterface`
42+
6. Extend `Channel` entity `UserComApiAwareTrait` and implement `UserComApiAwareInterface`
4343
```php
4444
use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareTrait;
4545
use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareInterface;
@@ -50,23 +50,22 @@
5050
}
5151
```
5252
53-
>`UserComApiAwareTrait` contains mapping for annotations and for attributes which are required by UserCom integration.
54-
> If you're using xml mapping, you should add mapping for those properties in your `Channel.orm.xml` file.
53+
>`UserComApiAwareTrait` contains mapping for annotations and for attributes which are required by UserCom integration. If you're using xml mapping, you should add mapping for those properties in your `Channel.orm.xml` file.
5554
56-
6. Take advantage of channel based configuration of GoogleAnalyticsPlugin by adding :
55+
7. Take advantage of channel based configuration of GoogleAnalyticsPlugin by adding :
5756
```yaml
5857
spinbits_sylius_google_analytics4:
5958
id: "%env(GOOGLE_ANALYTICS_TAG)%"
6059
enabled: true
6160
```
62-
8. Run yarn install and yarn build to compile assets, or the alternative solution you use for your project
61+
8. Compile assets
6362
```bash
6463
yarn install && yarn build
6564
```
66-
7. Add api credentials and GTM to your channel configuration in admin panel. If you decided to extend different object, please make sure that api credentials are set
65+
9. Add API credentials and GTM to your channel configuration in admin panel. If you decided to extend different object, please make sure that API credentials are set.
6766
![Channel configuration](../doc/user_com_configuration.png)
68-
9. Configure consumer to run in supervisor:
67+
68+
10. Configure consumer to run in supervisor:
6969
```bash
7070
bin/console messenger:consume user_com_asynchronous
7171
```
72-
10. While integrating with User.com via GTM, you can use `user_com_customer_info` in browser console to check currently logged in customer data.

doc/user_com_configuration.png

-292 KB
Loading

tests/Application/.env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ USER_COM_FRONTEND_API_KEY=""
3737
GOOGLE_ANALYTICS_TAG=""
3838
USER_COM_ENCRYPTION_KEY=your-32-character-long-key
3939
USER_COM_ENCRYPTION_IV=your-16-character-long-
40-
MESSENGER_USER_COM_ASYNCHRONOUS="doctrine://default"
40+
MESSENGER_USER_COM_ASYNCHRONOUS_DSN="doctrine://default"
4141
###< UserCom

0 commit comments

Comments
 (0)