docs: added overview hook (#95)

README.md

@@ -10,7 +10,22 @@ This module implements an instance of the IBM Cloud Messages for RabbitMQ servic
 
 :exclamation: The module does not support major version upgrades or updates to encryption and backup encryption keys. To upgrade the version, create another instance of IBM Cloud Messages for RabbitMQ with the updated version and follow the steps in [Upgrading to a new Major Version](https://cloud.ibm.com/docs/messages-for-rabbitmq?topic=messages-for-rabbitmq-upgrading) in the IBM Cloud Docs.
 
-## Usage
+<!-- Below content is automatically populated via pre-commit hook -->
+<!-- BEGIN OVERVIEW HOOK -->
+## Overview
+* [terraform-ibm-icd-rabbitmq](#terraform-ibm-icd-rabbitmq)
+* [Submodules](./modules)
+    * [fscloud](./modules/fscloud)
+* [Examples](./examples)
+    * [Basic example](./examples/basic)
+    * [Complete example with BYOK encryption, CBR rules, autoscaling, and service credentials creation](./examples/complete)
+    * [Financial Services Cloud profile example with autoscaling enabled](./examples/fscloud)
+* [Contributing](#contributing)
+<!-- END OVERVIEW HOOK -->
+
+## terraform-ibm-icd-rabbitmq
+
+### Usage
 
 IBM Cloud Messages for RabbitMQ supports only Key Protect encryption for backups, not Hyper Protect Crypto Services. If you enable key management encryption and no value is passed for 'backup_encryption_key_crn', the value of 'kms_key_crn' is used. And if a HPCS value is set for `kms_key_crn`, the database backup encryption uses the default encryption keys. For more information, see [Hyper Protect Crypto Services Integration](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs) in the IBM Cloud Docs.
 
@@ -25,7 +40,7 @@ module "rabbitmq" {
 ```
 
 
-## Required IAM access policies
+### Required IAM access policies
 
 You need the following permissions to run this module.
 
@@ -34,13 +49,7 @@ You need the following permissions to run this module.
         - `Editor` role access
 
 <!-- END MODULE HOOK -->
-<!-- BEGIN EXAMPLES HOOK -->
-## Examples
 
-- [ Basic example](examples/basic)
-- [ Complete example with BYOK encryption, CBR rules, autoscaling, and service credentials creation](examples/complete)
-- [ Financial Services Cloud profile example with autoscaling enabled](examples/fscloud)
-<!-- END EXAMPLES HOOK -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ### Requirements