Skip to content

Commit a1648b0

Browse files
authored
Merge pull request #17 from iMattPro/readme
Update README
2 parents 0dbb1db + 602610b commit a1648b0

2 files changed

Lines changed: 33 additions & 14 deletions

File tree

.github/images/cm.png

37.8 KB
Loading

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,48 @@
1-
# Consent Manager
2-
3-
> This extension is under development and will become available on [phpBB.com](https://phpbb.com) when it's ready
1+
<div align="center">
42

3+
# Consent Manager
54
[![Build Status](https://github.com/phpbb-extensions/consent-manager/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbb-extensions/consent-manager/actions)
65
[![codecov](https://codecov.io/gh/phpbb-extensions/consent-manager/graph/badge.svg?token=IE2YWG6N9V)](https://codecov.io/gh/phpbb-extensions/consent-manager)
76
![Stability](https://img.shields.io/badge/stability-dev-orange?logo=phpBB&logoColor=white)
87

9-
Consent Manager is a GDPR-ready privacy/cookie consent management solution built for phpBB forums.
8+
<p><i>Modern cookie consent for phpBB</i></p>
9+
<kbd><img src=".github/images/cm.png" width="566" height="208" alt="Consent Manager" style="width:566px; height:auto; max-width: 100%; display: block;"></kbd>
10+
</div>
11+
12+
<br>
13+
14+
Simple, GDPR-ready privacy controls with category-based consent, ACP management tools, and extension-friendly integrations.
15+
16+
## Features
17+
18+
- Consent banner
19+
- Preference modal
20+
- Category-based controls
21+
- Consent logging
22+
- Version resets
23+
- ACP configuration
24+
- Extension integrations
25+
26+
Supported categories:
1027

11-
It adds a consent banner, settings modal, and category-based controls, allowing visitors to accept all, reject all, or choose specific cookie types. A footer link lets users revisit and update their preferences at any time.
28+
- Necessary
29+
- Analytics
30+
- Marketing
31+
- Embedded media
1232

13-
The extension also provides an easy integration point for other phpBB extensions, enabling them to make their non-essential scripts compliant.
33+
Necessary cookies stay enabled. The rest requires consent.
1434

15-
Out of the box, Consent Manager supports these categories:
35+
## Built for phpBB admins
1636

17-
- Necessary (always on)
18-
- Analytics (optional)
19-
- Marketing (optional)
20-
- Embedded media (optional)
37+
Manage categories, integrations, consent resets, and audit logs directly from the ACP.
2138

22-
It also includes ACP settings for enabling categories, simple admin-managed integrations, detailed consent logging for audit and compliance purposes, and consent version resets to prompt users to review their choices when policies or integrations change.
39+
- No external consent platforms
40+
- No bloated configuration
41+
- No enterprise dashboards
2342

24-
## For extension authors
43+
## For phpBB extension developers
2544

26-
If your extension adds analytics, advertising, or other tracking or cookie-related JavaScript, you’ll want to integrate it with Consent Manager so those scripts only run after user consent is granted.
45+
Consent Manager makes it easy for extension authors to ensure analytics, embeds, advertising, and other non-essential scripts only load after user consent has been granted.
2746

2847
See the [Developer Documentation](DOCUMENTATION.md) for a complete guide.
2948

0 commit comments

Comments
 (0)