[FEATURE] Added Events documentation

Author: svenpet90

README.md

@@ -11,6 +11,7 @@ TYPO3 Extension "instagram"
 =================================
 
 ## What does it do?
+
 TYPO3 Extension to import and display instagram posts/feeds in a TYPO3 Website.
 
 Creates and auto-refreshes long-lived api access tokens, imports
@@ -23,16 +24,22 @@ Frontend-Plugin.
 * Automatic refreshing of API access tokens to keep them valid
 * Import multiple Instagram users feeds/posts
 * Uses official Instagram-API to access a users feed.
-* Provides commands to refresh access tokens and to import feeds via cronjob/scheduler
-* Downloads the posts (images/videos). No API calls needed when displaying them = no frontend performance impact.
+* Provides commands to refresh access tokens and to import feeds via
+  cronjob/scheduler
+* Downloads the posts (images/videos). No API calls needed when displaying
+  them = no frontend performance impact.
 * Display users feeds/posts in any way you like
 * Based on Extbase and Fluid
 
 ## Installation
-The recommended way to install the extension is by using [Composer](https://getcomposer.org/). In your Composer based TYPO3 project root, just do:
+
+The recommended way to install the extension is by
+using [Composer](https://getcomposer.org/). In your Composer based TYPO3 project
+root, just do:
 <pre>composer require svenpetersen/instagram</pre>
 
 ## Setup
+
 1. Include the provided static TypoScript
 2. Create a Facebook "Instagram Basic Display" App: See the
    [official Documentation](https://developers.facebook.com/docs/instagram-basic-display-api/getting-started)
@@ -50,13 +57,15 @@ __Recommended__:
 * Add a cronjob/scheduler task to import the posts on a regular basis
 
 ## Compatibility
+
 | Version | TYPO3       | PHP        | Support/Development                  |
 |---------|-------------|------------|--------------------------------------|
 | 1.x     | 10.4 - 11.5 | 7.4 - 8.0️ | Features, Bugfixes, Security Updates |
 
 ## Funtionalities
 
 ### Automatic import of posts
+
 This extension comes with a command to import (new) posts of a given instagram
 user.
 It is recommended to set this command up to run regularly - e.g. once a day.
@@ -79,8 +88,8 @@ __Options:__
 | --since | Date string to fetch posts since (Format: "MM/DD/YYYY H:i:s"). |
 | --until | Date string to fetch posts until (Format: "MM/DD/YYYY H:i:s"). |
 
-
 ### Automatic Access Token Refreshing
+
 The generated long-lived access token is valid for 60 days.
 It can be refreshed when at least 24 hours old.
 
@@ -92,6 +101,7 @@ Make sure to run this command regularly - e.g. once a day via a
 cronjob/scheduler - in order to keep your access token valid.
 
 ### Disable/enable Backend module "Token Generator"
+
 To disable the Backend module - e.g. after you generated all needed tokens - add
 this
 line to the <code>LocalConfiguration.php/AdditionalConfiguration.php</code>:
@@ -100,17 +110,36 @@ line to the <code>LocalConfiguration.php/AdditionalConfiguration.php</code>:
 ## Extending
 
 ### Additional Template Selector
-If you need a kind of template selector inside a plugin, you can add your own selections by adding those to:
+
+If you need a kind of template selector inside a plugin, you can add your own
+selections by adding those to:
 <pre>$GLOBALS['TYPO3_CONF_VARS']['EXT']['instagram']['templateLayouts']['myext'] = ['My Title', 'my value'];</pre>
 
 ### Local path to save downloaded files
-By default all images/videos in imported posts are saved in <code>/public/fileadmin/instagram</code>
-You can change this path via the Extensions settings <code>local_file_storage_path</code> option.
+
+By default all images/videos in imported posts are saved in <code>
+/public/fileadmin/instagram</code>
+You can change this path via the Extensions settings <code>
+local_file_storage_path</code> option.
+
+### Events
+
+This extension comes with a few events for you to listen to and add your own
+logic:
+
+| Name                 | Args.                                             | Description                                                                                                                                  |
+|----------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| PreRenderActionEvent | ViewInterface $view <br> string $action           | Dispatched before the view is rendered. Can be used to modify the view object. E.g. adding additional vars to the frontend (e.g. pagination) |
+| PrePersistPostEvent  | Post $post <br> string $action['new' or ‘update'] | Dispatched before a Post is saved. Can be used to modify the Post entity.                                                                    | Dispatched before the view is rendered. Can be used to modify the view object. E.g. adding additional vars to the frontend (e.g. pagination) |
+| PostPersistPostEvent | Post $post                                        | Dispatched after a Post is saved.                                                                                                            | Dispatched before the view is rendered. Can be used to modify the view object. E.g. adding additional vars to the frontend (e.g. pagination) |
 
 ## Contributing
-Please refer to the [contributing](CONTRIBUTING.md) document included in this repository.
+
+Please refer to the [contributing](CONTRIBUTING.md) document included in this
+repository.
 
 ## Testing
+
 This Extension comes with a testsuite for coding styles and unit/functional
 tests.
 To run the tests simply use the provided composer script: