diff --git a/README.md b/README.md index 732275e..be14646 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,22 @@ This project was created in collaboration with [Sharon Brizinov](https://github. ```bash pip install -r requirements.txt ``` -3. Scan an org/user for secrets: + +3. Install TruffleHog (v3 or later — required for secret scanning): + +#### macOS (Homebrew): +```bash +brew install trufflehog +``` + +#### Linux / Other: +Download the latest binary from the [Releases page](https://github.com/trufflesecurity/trufflehog/releases), or use: + +```bash +go install github.com/trufflesecurity/trufflehog@latest +``` + +4. Scan an org/user for secrets: ```bash python force_push_scanner.py --db-file /path/to/force_push_commits.sqlite3 --scan