Skip to content

Commit 3c523fd

Browse files
author
Ashley Baldwin-Hunter
authored
Add path config example to README (#53)
* Add path config example to README
1 parent db5b9d9 commit 3c523fd

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ bundler-audit offers patch-level verification for [Bundler](http://bundler.io/).
1212
2. Run `codeclimate engines:enable bundler-audit`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
1313
3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
1414

15+
### Configuration
16+
17+
By default, bundler-audit will look for a `Gemfile.lock` file in the root of
18+
your project. Optionally configure Code Climate to look at a different path:
19+
20+
```yml
21+
plugins:
22+
bundler-audit:
23+
enabled: true
24+
config:
25+
path: optional/path/to/Gemfile.lock
26+
```
27+
1528
### Updating the vulnerability database
1629
1730
If you want to update the vulnerability database, run

0 commit comments

Comments
 (0)