Skip to content

Commit

Permalink
Add visual assets and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
michaloo committed Mar 4, 2024
1 parent 9c5dc81 commit 87a7be5
Show file tree
Hide file tree
Showing 11 changed files with 93 additions and 3 deletions.
34 changes: 31 additions & 3 deletions .env.dist
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
WORDPRESS_DB_HOST=mariadb
WORDPRESS_DB_USER=root
WORDPRESS_VERSION=latest
# To test on specific PHP version:
# WORDPRESS_VERSION=6.0.0-php8.0-apache

WORDPRESS_LOCALE=en_US

MYSQL_DATABASE=database
MYSQL_USER=user
MYSQL_PASSWORD=password
MYSQL_ROOT_PASSWORD=test

DB_HOST=mysql
DB_CHARSET=
DB_COLLATE=
TABLE_PREFIX=wp_

WP_DEBUG=true
WP_DEBUG_LOG=
WP_CACHE=
WPCACHEHOME=
UPLOADS=

FS_METHOD=
DISABLE_WP_CRON=
DISALLOW_FILE_EDIT=
TAR_OPTIONS=--no-same-owner
TAG_CONCIERGE_API_URL=https://beta-api.tagconcierge.com

WORDPRESS_DB_NAME=database
WORDPRESS_DB_USER=user
WORDPRESS_DB_PASSWORD=password
WORDPRESS_DB_NAME=wordpress
WORDPRESS_DB_HOST=mysql
Binary file added assets/icon-256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
=== GTM Consent Mode Banner ===
Contributors: Tag Concierge
Tags: google tag manager, consent mode, cookies banner, privacy
Requires at least: 5.1.0
Tested up to: 6.2.2
Requires PHP: 7.0
Stable tag: 1.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Lightweight (1.9 kB) Consent/Cookies Banner compatible with GTM Consent Mode.

== Description ==

GTM Consent Mode Banner is a lightweight (1.9 kB), user-friendly WordPress plugin designed to integrate Google Tag Manager Consent Mode seamlessly into your website. It offers a simple and efficient way for website owners to comply with cookie and privacy regulations like GDPR and CCPA, by enabling visitors to select their cookie preferences easily.

## Features

- **Simple Setup**: Integrate with Google Tag Manager with minimal configuration.
- **Customizable Consent Banner**: Tailor the appearance and message of your consent banner.
- **User Preference Control**: Allows users to specify their consent for different types of cookies (e.g., necessary, analytics, marketing).
- **Compliance with Privacy** Laws: Helps in making your website compliant with GDPR, CCPA, and other privacy regulations.
- **Lightweight and Fast**: Designed to be non-intrusive and does not affect your website's load time.


== Installation ==

1. Upload or install `GTM Consent Mode Banner` plugin from WordPress plugins directory.
2. Activate the plugin through the `Plugins` menu in WordPress.
3. That's it! Consent State will be pushed to DataLayer adhering to Consent Mode API
4. Use plugin settings to customise the content and consent settings.
5. Optionally use plugin settings to install GTM snippets

== Frequently Asked Questions ==

= How to inject GTM tracking snippet? =

By default this plugin push consent information to the GTM DataLayer object that can be installed by other plugins or directly in the theme code.
It can also embed GTM snippets, go to settings to configure it.

= Do I need to configure anything in GTM to enable consent mode =

Once your Consent Banner is deployed you need to review all your GTM tags to ensure they have correct consent checks settings.
You can use Consent Overview screen to quickly review and update tags. [Read more here](https://docs.tagconcierge.com/article/59-how-to-configure-gtm-consent-mode)

== Screenshots ==

1. Consent Banner in action
2. Consent Banner displayed as modal
3. Consent Banner displayed as bar without "wall"
4. Consent Banner settings screen with all consent types listed
5. Consent Banner WP Admin basic settings
6. Consent Banner WP Admin banner content settings
7. Consent Banner WP Admin GTM snippets settings
8. Consent Banner WP Admin consent types settings


== Changelog ==

= 1.0.0 =

* Initial version

0 comments on commit 87a7be5

Please sign in to comment.