micc83 · JEric49 · Apr 24, 2018 · Apr 24, 2018 · Apr 24, 2018 · Apr 24, 2018
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,30 @@
+# https://travis-ci.org/nfreear/cookie-notice
+# https://docs.travis-ci.com/user/languages/javascript-with-nodejs/
+
+language: node_js
+
+node_js: "12"
+
+git:
+  depth: 8
+
+cache:
+  directories:
+  - node_modules # NPM packages.
+
+# install: npm install
+
+script: npm test
+
+after_script:
+  - ls -al dist/
+  - pgrep -lf '(live-server|phantom)'
+
+deploy:
+  provider: npm
+  email: bernhard.bezdek@googlemail.com
+  api_key: $NPM_TOKEN
+  on:
+    branch: master
+
+# End.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,104 @@
+
+# CookieNotice changelog
+
+← [README][]
+
+Version History
+
+## Version 1.3.4
+ * _Date: 24 November 2020_
+ * Changed default font size handling 
+ * New demo page
+ * new languages (pl, es, nl)
+ * configuration examples (images)
+
+
+## Version 1.1.19
+ * _Date: 09 July 2020_
+ * Added fontSize customization, with fallback to 12px if unset
+
+## Version 1.1.18
+ * _Date:  01 January 2019_;
+ * Step back to px based font sizes due to negative side effects
+
+ ## Version 1.1.17
+ * _Date:  15 December 2018_;
+ * Accessibility (a11y) improvements - fixed all WCAG2AA errors and warnings
+
+## Version 1.1.16
+ * _Date:  12 December 2018_;
+ * Initial font size too small
+
+ ## Version 1.1.14/15
+ * _Date:  6 December 2018_;
+ * Typo in German translation -> contrib. by @chroedermatthias (Matthias Schröder)
+ * Dependency upgrade
+ * Fixed unit tests
+
+## Version 1.1.12
+
+ * _Date:  approx. 4-6 June 2018_;
+ * Add accessibility testing via [grunt-rsids-pa11y][] and [pa11y][], WCAG 2.0 AA, pull #6;
+ * Accessibility fixes — colour contrast, button role, link target, link underline;
+ * Accessibility fixes — express CSS font-size in `em` or `rem`, not `px`;
+ * Add configuration option — `linkTarget` (default: '');
+ * Edit the language used in the English translation;
+ * Fix `browser` and `repository` fields in `package.json`;
+ * Add `files` and `bugs` fields to `package.json`;
+ * Add `engines` and `contributors` fields to `package.json`;
+ * Add `live-server` to `peerDependencies` in `package.json`;
+ * Remove Nick's email address from `README` & `bower.json` (!)
+
+## Version 1.1.11
+
+ * _Date:  30 May 2018_;
+ * Add support for `data-cookie-notice` attribute on `<script>`, pull #5, issue [#4][];
+ * Document `data-` attribute in README;
+ * Document _unpkg_ CDN in README;
+
+## Version 1.1.10
+
+ * _Date:  29 May 2018_;
+ * Move jQuery to `devDependencies` for clarity, pull #2;
+ * Point `tests/index.html` to local copies of jQuery and QUnit (was CDN);
+
+## Version 1.1.9
+
+ * _Date:  25 May 2018_;
+ * Add Travis-CI testing to the project, pull #1;
+ * Update test dependencies —
+   jQuery from 2.x → 3.x; QUnit from 1.x → 2.x;
+ * Add SVG badges for Travis-CI, NPMJS.com, etc. to `README.md`;
+
+## Version 1.1.8
+
+ * _Date:  25 May 2018_;
+
+## Version 1.1.7
+
+ * _Date:  25 April 2018_;
+
+...
+
+## Version 1.1.0
+
+ * _Date:  24 April 2018_;
+ * First release on [npm][];
+
+## Version 1.0.0
+
+ * _Date:  20 May 2015_;
+ * Release by:  [@micc83][];
+ * (Not on [npm][])
+
+---
+
+← [README][]
+
+[readme]: https://github.com/AOEpeople/cookie-notice#readme
+[npm]: https://www.npmjs.com/package/cookie-notice
+[@micc83]: https://github.com/micc83/cookie-notice-js "Alessandro Benoit"
+[#4]: https://github.com/AOEpeople/cookie-notice/issues/4
+[a11y-fail]: https://travis-ci.org/nfreear/cookie-notice/jobs/387344672#L1217-L1235
+[grunt-rsids-pa11y]: https://www.npmjs.com/package/grunt-rsids-pa11y
+[pa11y]: http://pa11y.org/
diff --git a/README.md b/README.md
@@ -1,74 +1,207 @@
-# CookieNoticeJS
+[![Build status — Travis-CI][travis-icon]][travis]
+[![cookie-notice on Npmjs][npm-icon]][npm]
+[![License][license-icon]][mit]
+[![Total downloads ~ Npmjs][downl-icon]][npm]
+[![Size of Javascript][size-icon]][build]
 
-**CookieNoticeJS** is a very simple and small *(→ 2 kB gzip)* vanilla JS script that provides an easy way to show that damn cookie notice on your website.
-Simply add the following tag to your website footer:
+# CookieNotice
+
+**CookieNoticeJS** is a very simple, extendable and small *(→ 2 kB gzip)* vanilla JS script with multi language support
+for [GDPR][]/[DSGVO][]‎ transparency and notification purposes that provides an easy way to show a cookie notice on your
+website.
+
+**Cookie notice at the bottom of the page**
+<img src="https://i.imgur.com/xodbOdi.png" alt="cookie notice working example" align="center"/>
+
+**Cookie notice at the top of the page**
+<img src="https://i.imgur.com/XOfijh6.png" alt="cookie notice working example" align="center"/>
+
+**Available via [npm][]**
+
+```shell
+npm install cookie-notice
+npm test
+```
+
+**To use in your project There are plenty ways for integration:**
+
+**When installed via npm, include in any project by using path below:**
 
 ```html
-<script src="js/cookie.notice.min.js"></script>
+
+<script src="node-modules/cookie-notice/dist/cookie.notice.min.js"></script>
+```
+
+**For usage with Angular2+ add line below in "scripts" section in angular-cli.json:**
+
+```json
+{
+    "scripts": [
+        "../node_modules/cookie-notice/dist/cookie.notice.js",
+        "../optional/path/to/custom/cookie-notice-config.js"
+    ]
+}
+```
+
+**When cloned directly from gitHub use path below:**
+
+```html
+
+<script src="cookie-notice/dist/cookie.notice.min.js"></script>
 ```
 
-And you will get a dismissable banner on the bottom of your pages showing a default cookie audit like the following:
+## Behavior
+
+You will get a dismissable banner on the bottom of your pages showing a default cookie audit like the following:
 
 > We use cookies to make sure you can have the best experience on our website. If you continue to use this site we assume that you will be happy with it.
-
-Check my website for a [DEMO](http://codeb.it/). Depending on the visitor browser language one of the preloaded translation will be shown. At the moment **CookieNoticeJS** supports *EN, IT, DE and FR*. If you want to contribute with an extra language do not hesitate to open an issue or a PR.
 
-**CookieNoticeJS** has been succesfully tested on IE9+, Chrome, Firefox and Safari.
+You can check out an example integration
+at [Deutsche Telekom](https://breitband.telekom-dienste.de/kundencenter-breitband).
+
+Depending on the visitor browser language one of the preloaded translations will be shown. At the moment **
+CookieNoticeJS** supports following languages out of the box:
+
+- IT (Italiano)
+- EN (English) `default`
+- FR (Français)
+- PT (Português)
+- ES (Español)
+- NL (Nederlands)
+- DE (Deutsch)
+- PL (Polski)
+
+> You can also add any other language code
+
+If you want to contribute with an extra language or find translation issues do not hesitate to open an issue or a PR.
+
+**CookieNoticeJS** has been successfully tested on IE9+, Chrome, Firefox and Safari.
 
 ## Customize CookieNoticeJS
 
-For the most of you including the script should be enough but **CookieNoticeJS** comes with many customization options. Let's see an example:
+For the most of you including the script should be enough but **CookieNoticeJS** comes with many customization options.
+Let's see an example:
 
 ```html
+
 <script src="js/cookie.notice.min.js"></script>
 <script>
     new cookieNoticeJS({
-
-       // Localizations of the notice message
-       'messageLocales': {
-         'it': 'Custom localized message'
-       },
-
-       // Localizations of the dismiss button text
-       'buttonLocales': {
-         'it': 'Chiudi'
-       },
-
-       // Position for the cookie-notifier (default=bottom)
-       'cookieNoticePosition':'top'
-
-       // Shows the "learn more button (default=false)
-       'learnMoreLinkEnabled':false
-
-       // The href of the learn more link must be applied if (learnMoreLinkEnabled=true) 
-       'learnMoreLinkHref':'/learn/more/index.html'
-
-       // Text for optional learn more button
-       'learnMoreLinkText':{
-           'en':'learn more'
-       },
-
-       // The message will be shown again in X days
-       'expiresIn': 30, 
-
-       // Dismiss button background color
-       'buttonBgColor': '#d35400',  
-
-       // Dismiss button text color
-       'buttonTextColor': '#fff', 
-
-       // Notice background color
-       'noticeBgColor': '#000', 
-
-       // Notice text color
-       'noticeTextColor': '#fff' 
-
-       // the lernMoreLink color (default='#009fdd') 
-       'linkColor':'#f00'
-
+
+        // Localizations of the notice message
+        'messageLocales': {
+            'it': 'Custom localized message'
+        },
+
+        // Localizations of the dismiss button text
+        'buttonLocales': {
+            'it': 'Chiudi'
+        },
+
+        // Position for the cookie-notifier (default=bottom)
+        'cookieNoticePosition': 'top',
+
+        // Shows the "learn more button (default=false)
+        'learnMoreLinkEnabled': false,
+
+        // The href of the learn more link must be applied if (learnMoreLinkEnabled=true)
+        'learnMoreLinkHref': '/learn/more/index.html',
+
+        // Text for optional learn more button
+        'learnMoreLinkText': {
+            'en': 'learn more'
+        },
+
+        // The message will be shown again in X days
+        'expiresIn': 30,
+
+        // Specify a custom font family and size in pixels
+        'fontFamily': 'inherit',
+        'fontSize': '12px',
+
+        // Dismiss button background color
+        'buttonBgColor': '#d35400',
+
+        // Dismiss button text color
+        'buttonTextColor': '#fff',
+
+        // Notice background color
+        'noticeBgColor': '#000',
+
+        // Notice text color
+        'noticeTextColor': '#fff',
+
+        // the learnMoreLink color (default='#009fdd')
+        'linkColor': '#f00',
+
+        // The target of the learn more link (default='', or '_blank')
+        'linkTarget': '',
+
+        // Print debug output to the console (default=false)
+        'debug': false
     });
 </script>
 ```
 
+## Configuration via `data-` attribute
+
+Configuration options can be put in a `data-cookie-notice` HTML attribute in JSON format. Note, you can include the
+Javascript from the [unpkg][] CDN ([browse][]). For example:
+
+```html
+
+<script
+    data-cookie-notice='{ "learnMoreLinkEnabled": true, "learnMoreLinkHref": "/privacy.html" }'
+    src="https://unpkg.com/cookie-notice@^1/dist/cookie.notice.min.js"
+></script>
+```
+
+#### Author
+
+Alessandro Benoit
+
 #### Contributors
-[Bernhard Behrendt](mailto:bernhard.behrendt@aoe.com) [@AOEpeople](https://github.com/AOEpeople)
+
+- [Bernhard Behrendt](mailto:bernhard.behrendt@aoe.com) [@AOEpeople](https://github.com/AOEpeople),
+- [Nick Freear](https://github.com/nfreear) [IET at the OU](https://github.com/IET-OU)
+- [Matthias Schröder](https://github.com/schroedermatthias)
+- [Andrea Bergamasco](https://github.com/vjandrea)
+
+### License
+
+License: [MIT][]
+
+
+[MIT]: https://github.com/micc83/cookie-notice-js/blob/master/LICENSE
+"License: MIT | Copyright © 2018 Alessandro Benoit (micc83)."
+
+[MIT-0]: https://mit-license.org/#2018
+
+[travis-icon]: https://travis-ci.org/AOEpeople/cookie-notice.svg?branch=master
+
+[travis]: https://travis-ci.org/AOEpeople/cookie-notice "Build status – Travis-CI"
+
+[npm]: https://npmjs.com/package/cookie-notice "CookieNotice – on NPM"
+
+[npm-icon]: https://badge.fury.io/js/cookie-notice.svg
+
+[npm-i0]: https://img.shields.io/npm/v/cookie-notice.svg "(Timeout errors)"
+
+[license-icon]: https://img.shields.io/npm/l/cookie-notice.svg
+
+[downl-icon]: https://img.shields.io/npm/dt/cookie-notice.svg "Count of total downloads – NPM"
+
+[build]: https://github.com/AOEpeople/cookie-notice/tree/master/dist
+
+[size-icon]: https://img.shields.io/github/size/AOEpeople/cookie-notice/dist/cookie.notice.min.js.svg
+"Size of built Javascript, kilo-bytes (kB) – on GitHub"
+
+[unpkg]: https://unpkg.com/ "unpkg is a fast, global content delivery network (CDN) for everything on npm."
+
+[browse]: https://unpkg.com/cookie-notice@^1/ "Browse cookie-notice on unpkg"
+
+[DSGVO]: https://de.wikipedia.org/wiki/Datenschutz-Grundverordnung "Datenschutz-Grundverordnung (DSGVO)"
+
+[GDPR]: https://en.wikipedia.org/wiki/General_Data_Protection_Regulation "General Data Protection Regulation (GDPR)"
+
+[End]: //.