..  include:: ../Includes.rst.txt

..  _installation:

==================
Installation steps
==================

*   Install using composer:
..  code-block:: pn

    composer require edia/edia-readability

*   Include main TypoScript setup and constants files
*   Set the api token constant (obtain a API key from `<https://edia.nl/developers>`__)
..  code-block:: typoscript

    plugin.tx_ediareadability.settings.api.token = <api-token>
*   Setup the symfony command 'edia:readability' to analyse the content elements periodically
..  code-block:: pn

    vendor/bin/typo3 edia:readability <api-token>

*   Enable the ckeditor plugin by adding the following line to the RTE configuration
..  code-block:: yaml

   imports:
       - { resource: "EXT:edia_readability/Configuration/RTE/Plugin.yaml" }

Additional steps for frontend
-----------------------------

.. toctree::
	:maxdepth: 1
	:titlesonly:

	Frontend/Index