From 979c8e8b14414d758cd8018a7ca0ae0791bc56b4 Mon Sep 17 00:00:00 2001 From: jrozanski Date: Mon, 27 Jan 2025 21:36:07 +0000 Subject: [PATCH] Setting documentation --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 385db50..0102a97 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ [![Downloads][npm-downloads-src]][npm-downloads-href] [![Wide Angle][wideangle-src]][wideangle-href] + + Enable **privacy-friendly** web analytics in your Vue.js 3.x application with our official plugin. [Wide Angle Analytics](https://wideangle.co) is powerful, strictly-GDPR compliant Google Analytics alternative. @@ -38,10 +40,11 @@ option|description|required|default|example siteId| The Site ID from Wide Angle Site settings| :white_check_mark: | _none_ | 8D27G3B9ACA01F4241 domain| Domain hosting the script, can be found in Wide Angle Analytics Site settings | :white_check_mark: | _none_ | stats.wideangle.co fingerprint | Should script use browser fingerprinting; this might require collecting consent depeing on the applicable laws | :x: | false | true -supressDnt | Should script ingore Do Not Track browser setting. If not enabled, not events will be sent if user's browser has DNT enabled | :x: | false | true +suppressDnt | Should script ingore Do Not Track browser setting. If not enabled, not events will be sent if user's browser has DNT enabled | :x: | false | true includeParams | An array of query parameters that can be passed as part of tracking event. By default only `utm_*` and `ref` parameters are passed in the event | :x: | `[]` | `['sessionId', 'offset']` excludePaths | An array of URL paths that should not trigger default events such as page view, page leave | :x: | `[]` | `['^/wp-admin/.*', ]` ignoreHash | If enabled, change in the URL fragment will not trigger page view event | :x: | false | true +consentMarker | Cookie (with or without) value which present implies consent and absence lack its lack | false | n/a | `WAA_CONSENT=true` You will find more details about these settings in [Wide Angle Analytics documentation](https://wideangle.co/documentation/configure-site).