File tree Expand file tree Collapse file tree 1 file changed +13
-14
lines changed
Expand file tree Collapse file tree 1 file changed +13
-14
lines changed Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ A simple telemetry library for WordPress.It allows you to send telemetry data to
44
55## Usage
66
7- ### 1. Install the Package
7+ ### 1. Installation
88
99Install the package using composer:
1010
@@ -32,40 +32,39 @@ function initialize_telemetry_client() {
3232initialize_telemetry_client();
3333```
3434
35+ You are good to go! The telemetry client will start sending data to the default server.
36+
3537## Configuration
3638
37- ### # Client
39+ All the configuration should be done in the ` initialize_telemetry_client() ` function.
40+
41+ ### # Telemetry Client Config
3842
39- Config the server URL
43+ Set custom server URL
4044
4145``` php
4246$telemetryClient->setServerUrl( 'https://example.com' );
4347```
4448
45- Config the terms URL
49+ Set custom terms URL
4650
4751``` php
4852$telemetryClient->setTermsUrl( 'https://example.com/terms' );
4953```
5054
51- Config the privacy policy URL
55+ Set custom privacy policy URL
5256
5357``` php
5458$telemetryClient->setPolicyUrl( 'https://example.com/privacy' );
5559```
5660
57- Config the plugin logo
58-
59- ``` php
60- $telemetryClient->setLogo( 'https://example.com/logo.svg' );
61- ```
62-
63- ### # Report
61+ ### # Tracking Report Config
6462
6563Add plugin information in tracking data
6664
6765``` php
68- $telemetryClient->report()->addPluginData();
66+ $telemetryClient->report()
67+ ->addPluginData();
6968```
7069
7170Add extra information in tracking data
@@ -77,7 +76,7 @@ $telemetryClient->report()
7776 ]);
7877```
7978
80- ### # Feedback
79+ ### # Deactivate Feedback Config
8180
8281You can customize the feedback survey by adding questions using ` add_filter() `
8382
You can’t perform that action at this time.
0 commit comments