=== Orejime ===

Contributors: boscop
Tags: gdpr, cookies, banner, consent, privacy
Stable Tag: 0.1.0
Requires PHP: 7.0
Requires at least: 5.5
Tested up to: 7.0
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.html

This plugin integrates Orejime, a lightweight and accessible consent manager, to WordPress.

== Description ==

The plugin provides built-in integrations to core WordPress functionalities and major analytics plugins, as to help implementing a consent banner.

Major WordPress plugins are automatically discovered and added to the banner.

One can then fine tune the configuration or even add custom entries.

= Integrations =

Besides letting you manually configure purposes, the plugin provides built-in integrations to core WordPress functionalities and major analytics plugins.

* [Embed blocks](https://wordpress.com/support/wordpress-editor/blocks/embed-block)
* [GA Google Analytics plugin](https://wordpress.org/plugins/ga-google-analytics/)
* [Google Site Kit plugin](https://wordpress.org/plugins/google-site-kit)
* [Jetpack plugin](https://wordpress.org/plugins/jetpack)
* [Matomo plugin](https://wordpress.org/plugins/matomo)
* [Monster Insights plugin](https://wordpress.org/plugins/google-analytics-for-wordpress)

= Contextual consent =

A custom editor block allows one to block any content until the user gives their explicit consent.
This would display a placeholder allowing the user to do so on the spot.
When they does, the placeholder is replaced by the intended content.

This block can be used around any other block or list of blocks, as the core `group` block.

The contextual consent placeholder can be added automatically to any `embed` blocks.

= Legal disclaimer =

Orejime is developed and updated by the Boscop teams in accordance with regulatory developments and European and French recommendations (particularly those of the EDPB and the CNIL).

However, the compliance of a cookie manager largely depends on the solution's configuration (from the handling of each cookie, to color choices, and the information provided to users).

It is your responsibility to verify your site's compliance, and Boscop cannot be held liable for any compliance issues arising from users of the Orejime plugin.

== Frequently Asked Questions ==

= Does using this plugin makes my website fully compliant? =

This plugin helps you configure a consent banner by providing presets for commonly used plugins.
However, you should always review its output and tune it accordingly.

See the legal disclaimer for more info.

= Where is the source code available? =

The full code and history is available [here at GitHub](https://github.com/boscop-fr/orejime-wordpress-plugin).

= Where can I report issues or ask for help? =

You can use the GitHub project's [issues](https://github.com/boscop-fr/orejime-wordpress-plugin/issues) and [discussions](https://github.com/boscop-fr/orejime-wordpress-plugin/discussions).

== Development ==

= Architecture =

The plugin revolves around the concept of "integrations".
An integration is a bridge between Orejime and a WordPress plugin or native feature.

Every integration derives from the base [`Integration`](./includes/class-integration.php) class.
They must each have unique identifiers and names, and should provide a way to tell if their target integration is currently active.
They hook into their target to alter their output, typically as to modify scripts so they can be handled by Orejime.

For every active integration, Orejime would register an associated purpose, which allows for customizing the info that is shown to the end user.

= Initial setup =

`npm install # installs build & run environment`
`npm run up # starts docker containers`
`npm run composer install # installs backend dev environment`

= Build =

`npm start # builds assets and watches for changes`

= Quality =

`npm run lint # lints JS and PHP code`
`npm run format  # formats JS and PHP code`

= Orejime integration =

The orejime library is provided by the plugin.
Its source code is [available at GitHub](https://github.com/boscop-fr/orejime).
Build files are sourced from the [official npm module](https://www.npmjs.com/package/orejime), installed via npm, then copied over to the `public` folder via a build task:

`npm run package-orejime`

This task is run automatically by other build tasks such as `npm start` & `npm run build`.

== Changelog ==

= 0.1.0 =

* Feature - Embed blocks integration.
* Feature - GA Google Analytics integration.
* Feature - Google Site Kit integration.
* Feature - Jetpack integration.
* Feature - Matomo integration.
* Feature - Monster Insights integration.