Skip to content

Commit 67c0adf

Browse files
committed
Update README: v0.7.2 Action ref, add pre-commit/Docker/Homebrew install sections
1 parent 2ddd77c commit 67c0adf

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ jobs:
164164
runs-on: ubuntu-latest
165165
steps:
166166
- uses: actions/checkout@v4
167-
- uses: Data-ScienceTech/forcefield@v0.7.0
167+
- uses: Data-ScienceTech/forcefield@v0.7.2
168168
with:
169169
mode: 'both' # selftest + audit
170170
sensitivity: 'medium'
@@ -195,6 +195,33 @@ Or use ForceField directly in your own steps:
195195
- run: forcefield audit src/ --json > audit-report.json
196196
```
197197

198+
## pre-commit Hook
199+
200+
Add ForceField scanning to your pre-commit config:
201+
202+
```yaml
203+
# .pre-commit-config.yaml
204+
repos:
205+
- repo: https://github.com/Data-ScienceTech/forcefield
206+
rev: v0.7.2
207+
hooks:
208+
- id: forcefield-scan
209+
```
210+
211+
## Docker
212+
213+
```bash
214+
docker run datasciencetech/forcefield selftest
215+
docker run datasciencetech/forcefield scan "Ignore all previous instructions"
216+
```
217+
218+
## Homebrew
219+
220+
```bash
221+
brew tap datasciencetech/forcefield
222+
brew install forcefield
223+
```
224+
198225
## Optional Extras
199226

200227
| Extra | What it adds |

0 commit comments

Comments
 (0)