change readme

.github/workflows/static-analysis.yml

@@ -79,14 +79,10 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m venv venv
-        source venv/bin/activate
         python -m pip install --upgrade pip
         python -m pip install -r requirements/generated/requirements-development.txt
     - name: Run TruffleHog Scan
-      run: |
-        source venv/bin/activate
-        venv/bin/trufflehog3 filesystem .
+      run: trufflehog3 filesystem .
     - name: Check for Secrets
       if: failure()
       run: exit 1

README.md

@@ -62,6 +62,7 @@ For information on writing tests please see [here](./tests/README.md).
 The following will:
 - Generate requirement.txt files from files inside requirements/source/*.in and put them into requirements/generated/*.txt
 - Run linting checks with ruff
+- Run secret detection via trufflehog3
 
 ```shell
 pre-commit install
@@ -80,6 +81,14 @@ To format all files in the directory, run:
 ruff format
 ```
 
+### Manually running secret detection
+The trufflehog3 package looks for any exposed secrets in your project.
+
+To use trufflehog on your current project, run:
+```shell
+trufflehog3 filesystem .
+```
+
 ## Development
 For information on how to contribute please see the following:
 - ### Models - [app/models/README.md](./app/models/README.md)