Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattaereal authored Oct 24, 2024
1 parent 2c77820 commit 0228ec0
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <target>

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
Expand Down Expand Up @@ -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. (<https://github.com/aquasecurity/trivy>)
- [x] trufflehog: Finds and analyzes leaked credentials. (<https://github.com/trufflesecurity/trufflehog>) [Easy marketplace] (https://github.com/marketplace/actions/trufflehog-oss)
- [x] wait-for-secrets: Provides 2FA for GitHub Actions. (<https://github.com/step-security/wait-for-secrets>)
- [x] yarn-audit-fix: Adds missing fix functionality to yarn audit. (<https://www.npmjs.com/package/yarn-audit-fix>)
- [x] yarn-audit-fix: Adds missing fix functionality to yarn audit. (<https://www.npmjs.com/package/yarn-audit-fix>)

0 comments on commit 0228ec0

Please sign in to comment.