From 0228ec060b7fa95c2e62de1a53504352ddae7da6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mat=C3=ADas=20Aereal=20Ae=C3=B3n?= <388605+mattaereal@users.noreply.github.com> Date: Thu, 24 Oct 2024 16:50:53 -0300 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5f13cd1..cd0796b 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,25 @@ but have been or will be added to the repository with an explanation on how to r ### Firing up the container ```bash -% make Usage: make Targets: - build Build the Docker image with the software versions described in the .env file - release Build the Docker image with the software versions described in the .env file, but from a specific release of this repo - latest Build the Docker image with the latest version for each tool - exec Run an interactive shell inside the container + build "Build the Docker image with the software versions described in the .env file" + rebuild "Forces build, even if a previous image exists. Won't delete previous images" + release "Build the Docker image with the software versions described in the .env file, but from a specific release of this repo" + latest "Build the Docker image with the latest version for each tool" + exec "Run an interactive shell inside the container" + clean "Remove Docker image $(IMAGE_NAME) and wipe cache (CAREFUL)" Examples: make make build + make rebuild make release make latest make exec + make clean ``` ## Second step @@ -76,4 +79,4 @@ Well, go to **[how to use the tools inside](./HOWTO.md)** to understand how each - [x] trivy: Scans for vulnerabilities and misconfigurations in various environments. () - [x] trufflehog: Finds and analyzes leaked credentials. () [Easy marketplace] (https://github.com/marketplace/actions/trufflehog-oss) - [x] wait-for-secrets: Provides 2FA for GitHub Actions. () -- [x] yarn-audit-fix: Adds missing fix functionality to yarn audit. () \ No newline at end of file +- [x] yarn-audit-fix: Adds missing fix functionality to yarn audit. ()