Skip to content

Commit 83b5cab

Browse files
Expand README with usage guidance and add RECIPES link (#28)
Co-authored-by: Uğur Kontel <dev.ugurkontel@gmail.com>
1 parent d01504b commit 83b5cab

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,29 @@ releases:
7070
docker run --rm ghcr.io/dev-ugurkontel/surface-audit:latest \
7171
scan https://preview.example.com --fail-on HIGH
7272
```
73+
### When to use GHCR vs PyPI vs GitHub Action
7374

75+
- **GHCR (Container Image)**
76+
Use when you want a reproducible, containerized scan without installing dependencies locally.
77+
78+
- **PyPI (pip install)**
79+
Use when you prefer running `surface-audit` directly in your Python environment.
80+
81+
- **GitHub Action**
82+
Use when integrating scans into CI/CD workflows for automated checks.
83+
84+
85+
### Release artifacts, SBOMs, and signatures
86+
87+
- Release artifacts are available via GitHub releases.
88+
- SBOMs provide dependency transparency.
89+
- Signatures ensure integrity of published images and packages.
90+
91+
92+
### Related recipes
93+
94+
For more usage patterns, see:
95+
[`docs/RECIPES.md`](docs/RECIPES.md)
7496
## Security Regression Diff
7597

7698
```bash

0 commit comments

Comments
 (0)