Skip to content

Commit

Permalink
Merge pull request #1 from iteratec/doc/readme
Browse files Browse the repository at this point in the history
Update README with link to docs
  • Loading branch information
twwd authored Sep 5, 2024
2 parents dbe4047 + a984933 commit 989f241
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 989f241

Please sign in to comment.