Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with link to docs #1

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Update README with link to docs #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
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.