Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zoglo committed Mar 6, 2024
1 parent a89b799 commit 97618d9
Show file tree
Hide file tree
Showing 3 changed files with 142 additions and 12 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
<p align="center"><img src="https://www.oveleon.de/share/github-assets/contao-cookiebar/ccb_logo.svg" width="300"></p>
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/logo/ccb_light.svg">
<img src="docs/logo/ccb_light.svg" width="300" alt="Contao Cookiebar">
</picture>
</p>
<p align="center"><i>This cookie bar is for the Contao Open Source CMS and allows a visitor to define cookie & privacy settings for the website.</i></p>
<p align="center">
<a href="https://www.oveleon.de"><img src="https://img.shields.io/badge/oveleon-maintained-83aa0e?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABMAAAAUCAYAAABvVQZ0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA/xpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTQ1IDc5LjE2MzQ5OSwgMjAxOC8wOC8xMy0xNjo0MDoyMiAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIgeG1wTU06T3JpZ2luYWxEb2N1bWVudElEPSJ1dWlkOjVEMjA4OTI0OTNCRkRCMTE5MTRBODU5MEQzMTUwOEM4IiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOjM5MjZBNjQzMzZFQjExRUFBMTdBQkNFQTAxNjg2RDI4IiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOjM5MjZBNjQyMzZFQjExRUFBMTdBQkNFQTAxNjg2RDI4IiB4bXA6Q3JlYXRvclRvb2w9IkFkb2JlIElsbHVzdHJhdG9yIENTNiAoV2luZG93cykiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0idXVpZDplMDhkZDhmZC1mOTA4LTQ5YzItYWMwZC00OGE3YTI4ODc2YWEiIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6OTA2RDhGOENERUQxRTgxMTgyMjVBMzBGQ0NBNjE4RUQiLz4gPGRjOnRpdGxlPiA8cmRmOkFsdD4gPHJkZjpsaSB4bWw6bGFuZz0ieC1kZWZhdWx0Ij5Mb2dvX292ZWxlb25fWmVpY2hlbl9yejwvcmRmOmxpPiA8L3JkZjpBbHQ+IDwvZGM6dGl0bGU+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+P8iBTQAAAbFJREFUeNqU08srRFEcB/BromGGaJRHKSIaYfIm7JRSsvHIyuM/wMorNeEfUMqKnbKwU2TBwpSUSWYWFmSBDKWmWcgwcX2Pvrc5HXfuXL/6zD2P3z2Puedouq5rilG40JPxAuUmeX84tGTkwyXsghOWYQmKoFazExzVDXFIgEeazcPV9TCnzGplRiHMl7KgCWYghy9vQAasMEfkTqQarJ9JFWw0YlhJFv2rUv8tdKiDhTib0eiHQyhOsR2xyjlp0BF5MBELdr6WohE++X6raBOz6PwWCfiCOLzDN8sRGICYyfdrgBA8Q2kmfnzQJirghlw+XZANUQ5qFmHY52R9/9lWCXjBpbRPcaubDhtHsRoOuN1reAO/1H/PpzfdaqrggzOLK7YFD6zPMqeL9at0gwWZuKa0i3hkuZf1E6tteqEZnmCRbZVwxPIOn3V83litaogzbrPuhDOIwbyUd8q8SavBOpl0rnxROadFugkFVoOJAx1h4rRJvw9e2b9u3ACrY9ENAZaD/L/E0aiHMbbfQc3v7bFxWAchqptHAAqN3HQrM0JcsXFohzzexWPYk5N+BBgAix5VyvzRZbwAAAAASUVORK5CYII=" alt="Oveleon"></a>
Expand All @@ -8,13 +13,15 @@
<br/>

### Features

- Flexible script integration
- Vanilla JS
- Expandable
- Consent Log
- Free & Open Source

### Services

- Custom (Script)
- Custom (Template)
- Google Analytics
Expand All @@ -24,19 +31,20 @@
- Matomo Tag Manager
- etracker
- iFrame
- YouTube
- Vimeo
- Google Maps
- OpenStreetMap
- [add more...](docs/EXTEND_IFRAME.md)
- YouTube
- Vimeo
- Google Maps
- OpenStreetMap
- [add more...](docs/EXTEND_IFRAME.md)
- [add more...](docs/EXTEND_TYPE.md)

### Documentation

- [Install](docs/INSTALL.md)
- [Configuration (Basics)](docs/BASICS.md)
- [Create Configuration](docs/CONFIGURATION.md)
- [Create Group](docs/GROUP.md)
- [Create Cookie (Type)](docs/COOKIE.md)
- [Create Configuration](docs/CONFIGURATION.md)
- [Create Group](docs/GROUP.md)
- [Create Cookie (Type)](docs/COOKIE.md)
- [Module & Content-Element](docs/MOD_CE.md)
- [Styling & Customization](docs/CUSTOMIZATION.md)
- [Extend iFrame-Types](docs/EXTEND_IFRAME.md)
Expand All @@ -45,24 +53,31 @@
- [Content Security Policy](docs/CONTENT_SECURITY_POLICY.md)

### Contributing

To build JavaScript and CSS files the following commands can be used:

```npm
npm install
npm run-script buildjs
npm run-script buildcss
```

### Community Extensions
- [Contao Cookiebar Optin](https://github.com/postyou/contao-cookiebar-optin): Extends the cookie bar with an opt-in functionality for content elements. ([@postyou](https://github.com/postyou))

- [Contao Cookiebar Optin](https://github.com/postyou/contao-cookiebar-optin): Extends the cookie bar with an opt-in
functionality for content elements. ([@postyou](https://github.com/postyou))

<br>

---

> ### 🚫
> This Consent Tool does **not** need its own cookies. Please **do not refer to Oveleon** within your website, no data will be passed to Oveleon!
> This Consent Tool does **not** need its own cookies. Please **do not refer to Oveleon** within your website, no data
> will be passed to Oveleon!
---

> ### ⚖️
> We cannot guarantee complete legal security. Use this extension at your own risk or contact a lawyer if you are not sure about the configuration. Please understand that we cannot answer any legal questions. For questions of technical nature, feel free to contact us.
> We cannot guarantee complete legal security. Use this extension at your own risk or contact a lawyer if you are not
> sure about the configuration. Please understand that we cannot answer any legal questions. For questions of technical
> nature, feel free to contact us.
55 changes: 55 additions & 0 deletions docs/logo/ccb_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 97618d9

Please sign in to comment.