Skip to content

Commit 0ed6ae9

Browse files
authored
docs: update with new feature (#15)
1 parent 7d56cef commit 0ed6ae9

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,6 @@ npx codeguardian
4646
npx codeguardian --staged
4747
```
4848

49-
## Adding scripts to package.json
50-
you can add a script to your `package.json` to simplify running the scanner:
51-
52-
```json
53-
"scripts": {
54-
"scan": "codeguardian"
55-
}
56-
```
57-
5849
## Default config:
5950
If no config is provided, CodeGuardian uses built-in rules to scan for common secrets (API keys, tokens, etc.).
6051

@@ -111,6 +102,8 @@ When run with `--ci` the CLI exits with a non-zero code if any findings are dete
111102
---
112103

113104
- Rule-based scanning: configure regex rules (name, pattern, flags) to detect secrets.
105+
- Built-in detection for AWS, Azure, Google Cloud, Heroku, JWTs, Slack tokens, and more.
106+
- Scan performance stats: see time taken, memory usage, and file count at the end of each run.
114107
- `ignoreFiles`: glob list to skip noisy files (lockfiles, build artifacts).
115108
- Staged-file scanning: run only what will be committed (fast pre-commit checks).
116109
- Husky integration: optional pre-commit hooks to block commits locally.
@@ -124,3 +117,11 @@ When run with `--ci` the CLI exits with a non-zero code if any findings are dete
124117
- `--ci` — CI mode: exit non-zero when findings exist
125118
- `-v, --verbose` — verbose output
126119

120+
## Adding scripts to package.json
121+
you can add a script to your `package.json` to simplify running the scanner:
122+
123+
```json
124+
"scripts": {
125+
"scan": "codeguardian"
126+
}
127+
```

0 commit comments

Comments
 (0)