Skip to content

Commit

Permalink
[DOCS] Add img to readme (#77)
Browse files Browse the repository at this point in the history
  • Loading branch information
d0g0x01 authored Jul 24, 2023
1 parent 29e840a commit 6c86207
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
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.

0 comments on commit 6c86207

Please sign in to comment.