Skip to content

Commit 570b9d9

Browse files
committed
Update README to include maintainers section.
1 parent c009385 commit 570b9d9

1 file changed

Lines changed: 71 additions & 49 deletions

File tree

README.md

Lines changed: 71 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
1-
# GDPR Cookies
1+
GDPR Cookies
2+
======================
23

3-
This module aims to help site administrators follow the guidelines of
4-
the "General Data Protection Regulation" (GDPR) regarding user
4+
This module aims to help site administrators follow the guidelines of
5+
the "General Data Protection Regulation" (GDPR) regarding user
56
tracking and integration of third party content.
67

7-
GDPR Cookies lets you prevent scripts and embedded content
8+
GDPR Cookies lets you prevent scripts and embedded content
89
(e.g. videos) from being rendered until the user has given their
910
consent to do so.
1011

11-
Please note that installing and using this module does not mean your
12+
Please note that installing and using this module does not mean your
1213
website becomes GDPR compliant.
1314

14-
NB This is a renamed version of a port of the Drupal module
15+
NB This is a renamed version of a port of the Drupal module
1516
`blizz_vanisher`. It is recommended that users install this
1617
newer version which will be updated and improved as issues are
1718
reported.
1819

19-
## Details
20-
The new European "General Data Protection Regulation" (GDPR) decrees
21-
that the well-known yet simple "This website uses cookies" banner is
22-
no longer sufficient and aims to provide for more transparency on the
20+
### More Details
21+
The new European "General Data Protection Regulation" (GDPR) decrees
22+
that the well-known yet simple "This website uses cookies" banner is
23+
no longer sufficient and aims to provide for more transparency on the
2324
use of the website visitor's data.
2425

25-
As part of the new regulation websites are not allowed to set
26-
ANY cookie without explicit consent of the visitor. What first deems
27-
to be not that great an issue becomes a real problem when it comes to
28-
the integration of third party content - because website operators are
26+
As part of the new regulation websites are not allowed to set
27+
ANY cookie without explicit consent of the visitor. What first deems
28+
to be not that great an issue becomes a real problem when it comes to
29+
the integration of third party content - because website operators are
2930
also responsible for potential data usage by third parties.
3031

31-
## Does your website use
32+
### Does your website use
3233
+ Google Analytics?
3334
+ Youtube videos?
3435
+ Vimeo videos?
@@ -37,57 +38,78 @@ also responsible for potential data usage by third parties.
3738
+ Facebook plugins?
3839
+ Or any other content integrated via CDNs?
3940

40-
If using these or similar services you now have to get explicit
41-
permission from the site visitor to include content from these
41+
If using these or similar services you now have to get explicit
42+
permission from the site visitor to include content from these
4243
services into your website - BEFORE any display occurs!
4344

4445
GDPR Cookies integrates the cookie manager script `tarteaucitron.js`,
45-
which elegantly provides customization features to the website's
46-
end user and does all the heavy lifting for you. Simply install
46+
which elegantly provides customization features to the website's
47+
end user and does all the heavy lifting for you. Simply install
4748
the module, configure the services needed and you're done.
4849

49-
When configured, GDPR Cookies in conjunction with `tarteaucitron.js`
50-
prevents external services from being integrated into your website
50+
When configured, GDPR Cookies in conjunction with `tarteaucitron.js`
51+
prevents external services from being integrated into your website
5152
without proper consent.
5253

5354
This initial port to Backdrop is from Drupal release 7.x-1.3.
5455

55-
## Dependencies
56-
+ [Entity Plus module](https://github.com/backdrop-contrib/entity_plus)
57-
+ The `tarteaucitron.js` script library (v1.8.4) is included in the module
56+
Requirements <!-- Do not include this section if there are no requirements. -->
57+
------------
5858

59-
## Installation
60-
- Install this module using [the official Backdrop CMS instructions](https://backdropcms.org/guide/modules).
61-
- Use the configuration page at **admin/config/system/gdpr_cookies/settings**
62-
to control which services are provided and need user consent.
63-
- There are some challenges to initialising this module which adjusts
59+
This module requires that the following modules are also enabled:
60+
61+
* [Entity Plus module](https://github.com/backdrop-contrib/entity_plus)
62+
* The `tarteaucitron.js` library is bundled into this module
63+
64+
Installation <!-- This section is required. -->
65+
------------
66+
67+
- Install this module using the official Backdrop CMS instructions at
68+
https://docs.backdropcms.org/documentation/extend-with-modules.
69+
70+
- Visit the configuration page at Administration > Configuration > System >
71+
GDPR Cookies > Settings (admin/config/system/gdpr_cookies/settings)
72+
to control which services are provided and need user consent.
73+
74+
There are some challenges to initialising this module which adjusts
6475
according to the current cookies on the site. If experiencing difficulty,
65-
please clear cookies in your browser and set GDPR Cookies to detect
76+
please clear cookies in your browser and set GDPR Cookies to detect
6677
at least one of the inbuilt third party services.
67-
- The included `tarteaucitron.js` library has a number of language files
78+
79+
The included `tarteaucitron.js` library has a number of language files
6880
which provide in editable form the text of the on-screen messages.
69-
70-
## License
71-
This project is GPL v2 software. See the LICENSE.txt
72-
file in this directory for complete text.
73-
74-
The `tarteaucitron.js` script is released under the MIT license.
7581

76-
## References and Credits
77-
+ [tarteaucitron.js](https://github.com/AmauriC/tarteaucitron.js)
78-
+ '[The GDPR is here](https://www.youtube.com/watch?v=CyIFNsSHPxQ)' (video)
7982

80-
### Port to Backdrop
83+
Issues <!-- This section is required. -->
84+
------
85+
86+
Bugs and feature requests should be reported in [the Issue Queue](https://github.com/backdrop-contrib/gdpr_cookies/issues).
87+
88+
89+
Current Maintainers <!-- This section is required. -->
90+
-------------------
91+
92+
- None.
93+
94+
95+
Credits <!-- This section is required. -->
96+
-------
97+
98+
- Ported to Backdrop CMS by [Graham Oliver](https://github.com/Graham-72).
99+
- Maintainer of Blizz Vanisher for Drupal: Lars Rosenberg (rackberg).
100+
- Maintainer of Blizz Vanisher for Drupal: Christian Lamine (CHiLi.HH).
101+
- Maintainer of Blizz Vanisher for Drupal: marvin_B8.
102+
- [GDPR friendly cookie manager library](https://github.com/AmauriC/tarteaucitron.js)
103+
- Video: [The GDPR is here](https://www.youtube.com/watch?v=CyIFNsSHPxQ)
104+
105+
106+
License <!-- This section is required. -->
107+
-------
81108

82-
+ Graham Oliver (github.com/Graham-72)
109+
This project is GPL v2 software.
110+
See the LICENSE.txt file in this directory for complete text.
83111

84-
### Maintainers of Blizz Vanisher for Drupal:
112+
The `tarteaucitron.js` script is released under the MIT license.
85113

86-
+ Lars Rosenberg (rackberg)
87-
+ Christian Lamine (CHiLi.HH)
88-
+ marvin_B8
89114

90-
### Acknowledgement
91115

92-
This port to Backdrop would not, of course, be possible without all
93-
the work done by the developers and maintainers of the Drupal module.

0 commit comments

Comments
 (0)