diff --git a/CHANGELOG.md b/CHANGELOG.md index 03b86cd91..6bc5787e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] ### Added +- Add navigation to keycloak-config-cli README [#1185](https://github.com/adorsys/keycloak-config-cli/issues/1099) +### 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) diff --git a/README.md b/README.md index f69688c84..f6eae8db5 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,30 @@ [![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) + - [Supported Substitutions](#supported-substitutions) +- [Logging](#logging) + - [JSON Logging Support](#json-logging-support) + - [Log Level](#log-level) +- [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) + - [CLI Options / Environment Variables](#cli-options--environment-variables) + - [Keycloak Options](#keycloak-options) + - [Import Options](#import-options) + - [Spring Boot Options](#spring-boot-options) +- [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.