diff --git a/README.md b/README.md index d85c3cc..ca3e973 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,9 @@ For Docker, use the following command to run the detection container interactive sudo docker run --rm -it quay.io/crowdstrike/detection-container ``` +This will present a text user interface: +![detection-container Text User Interface](docs/images/cli-interface.png) + For Kubernetes environments, refer to the [vulnapp project](https://github.com/CrowdStrike/vulnapp) for running the detection container interactively. ### Non-interactive Mode @@ -94,6 +97,10 @@ For Docker, use the following command to run the detection container non-interac sudo docker run --rm quay.io/crowdstrike/detection-container ``` +Output will be sent to the console (via ``stdout``) regarding what detections are being generated. An example of running in non-interactive mode, plus output, is shown below: + +![non-interactive mode](docs/images/non-interactive.png) + For Kubernetes environments, use the following command to run the detection container non-interactively: ```bash