Skip to content

Commit 5b89493

Browse files
committed
Document include_rules usage in README
1 parent 9040041 commit 5b89493

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ engines:
1414
1515
## Configuration
1616
17-
This engine accepts `tags` and `cookbook_paths` in its configuration. Both
18-
values are optional:
17+
This engine accepts `tags`, `include_rules` and `cookbook_paths` in its
18+
configuration. All values are optional:
1919

2020
```yml
2121
engines:
@@ -28,6 +28,9 @@ engines:
2828
cookbook_paths:
2929
- libraries/mysql.rb
3030
- libraries/docker.rb
31+
include_rules:
32+
- rules/my_custom_rule.rb
33+
- rules/my_other_custom_rule.rb
3134
```
3235

3336
**NOTE**: `cookbook_paths`, when defined, are passed directly to Foodcritic and

0 commit comments

Comments
 (0)