Merge pull request #1187 from Motouom/Adding-a-navigation-menu

Add navigation menu to the README

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 ### Added
+- Added Navigation in the readme [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010)
+### Added
 - improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010)
 ### Fixed
 - Fix required action import handling for no-delete option [#834](https://github.com/adorsys/keycloak-config-cli/issues/834)

README.md

@@ -5,6 +5,22 @@
 [![codecov](https://codecov.io/gh/adorsys/keycloak-config-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/adorsys/keycloak-config-cli)
 [![GitHub license](https://img.shields.io/github/license/adorsys/keycloak-config-cli)](https://github.com/adorsys/keycloak-config-cli/blob/main/LICENSE.txt)
 
+# Table of Contents
+
+- [Config Files](#config-files)
+- [Variable Substitution](#variable-substitution)
+- [Logging](#logging)
+- [Supported Features](#supported-features)
+- [Compatibility with Keycloak](#compatibility-with-keycloak)
+- [Build this Project](#build-this-project)
+- [Run Integration Tests](#run-integration-tests)
+- [Run this Project](#run-this-project)
+- [Docker](#docker)
+- [Helm](#helm)
+- [Configuration](#configuration)
+- [Perform Release](#perform-release)
+- [Commercial Support](#commercial-support)
+
 # keycloak-config-cli
 
 keycloak-config-cli is a Keycloak utility to ensure the desired configuration state for a realm based on a JSON/YAML file. The format of the JSON/YAML file based on the export realm format. Store and handle the configuration files inside git just like normal code. A Keycloak restart isn't required to apply the configuration.
@@ -91,6 +107,8 @@ Further development requirements
 - Java Development Kit (JDK)
 - Docker Desktop or an alternative replacement (e.g Rancher Desktop)
 
+Before running `mvn verify`, you have to set the JAVA_HOME environment variable to prevent some test failures.
+
 ```shell
 ./mvnw verify