From a984933e9dfeee7b986035523c5764b4f81ae44e Mon Sep 17 00:00:00 2001 From: Max Maass Date: Thu, 5 Sep 2024 16:13:45 +0200 Subject: [PATCH] Update README with link to website Signed-off-by: Max Maass --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d1e8798..cc1eb20 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # kcwarden - Keycloak Configuration Auditor -kcwarden checks your Keycloak configuration for common misconfigurations and security vulnerabilities. +[kcwarden](https://iteratec.github.io/kcwarden/) checks your Keycloak configuration for common misconfigurations and security vulnerabilities. -## Installation +## Installation and Usage -TBD +Please see our [documentation on the project website](https://iteratec.github.io/kcwarden/). ## Development @@ -43,7 +43,3 @@ Afterward, the documentation can be built using `poetry run mkdocs build`. The static output is then located in the `site` directory. A development server that serves the documentation, watches for changes and automatically re-creates the site can be spun up using `poetry run mkdocs serve`. - -## Usage - -Documentation will follow. \ No newline at end of file