CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Right to left languages
 * Integrations

INTRODUCTION
------------

The module makes it easy to integrate with Gleap through the Gleap API key,
this will allow the customer to give their feedback in an intelligent way.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/issues/gleap

 * To submit bug reports and feature suggestions, or track changes:
   https://www.drupal.org/project/issues/gleap


REQUIREMENTS
------------

This module requires no modules outside of Drupal core.


INSTALLATION
------------
The installation of this module is like other Drupal modules,
install the module and enable it.


Install as you would normally install a contributed Drupal module.
Visit https://www.drupal.org/node/1897420 for further information.


CONFIGURATION
-------------

- Get the Gleap API key from https://app.gleap.io/ > Project > Settings > Installation.
- To Add Gleap API key from /admin/config/services/gleap.


RIGHT TO LEFT LANGUAGES
-----------------------

Which corner the Gleap widget uses is a property of the Gleap project, set in
the Gleap dashboard, so it is the same corner in every language. On a page that
reads right to left the module moves the widget to the mirror image of that
corner, keeping whatever offset the project configured, so it sits where the
reader expects a floating action rather than in the leading corner.

A site that would rather keep the widget in one physical corner in every
language can drop the mirroring by removing the gleap/rtl dependency in
hook_library_info_alter().
INTEGRATIONS
------------

Editoria11y (https://www.drupal.org/project/editoria11y)

The Editoria11y checker panel and the Gleap widget are both fixed to a bottom
corner of the viewport, so without help they overlap. When Editoria11y is
installed, Gleap measures the panel and raises its own widget just far enough to
clear it, and only while the two share a corner. Nothing has to be configured,
and the measurement is repeated whenever either widget is drawn or resized.

This is done through the DOM rather than Editoria11y's own API, so it works the
same on Editoria11y 2.x and 3.x.