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.

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

[DOCS] Add img to readme #77

Merged
merged 2 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# KubeHound

A Kubernetes attack graph tool. For an overview of the application architecture see the [design canvas](./docs/application/Architecture.excalidraw). To see the attacks covered see the [edge definitions](./docs/edges/).
A Kubernetes attack graph tool allowing automated calculation of attack paths between assets in a cluster

To contribute a new attack to the project follow the [attack guide](./docs/ATTACKS.md).
![Example Path](./docs/images/example-graph.png)

## Quick Links

+ For an overview of the application architecture see the [design canvas](./docs/application/Architecture.excalidraw)
+ To see the attacks covered see the [edge definitions](./docs/edges/)
+ To contribute a new attack to the project follow the [attack guide](./docs/ATTACKS.md)

## Run

Expand Down
Binary file added docs/images/example-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading