Skip to content

Commit

Permalink
README: Add note about copying default rules into config file (#96)
Browse files Browse the repository at this point in the history
  • Loading branch information
caitlinelfring authored Jul 7, 2021
1 parent 761a2f9 commit eb3be5b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,6 @@ This has whitelist from stdin

### Rules

A set of default rules is provided in [`pkg/rule/default.yaml`](https://github.com/get-woke/woke/blob/main/pkg/rule/default.yaml).

Configure your custom rules config in `.woke.yaml` or `.woke.yml`. `woke` uses the following precedence order. Each item takes precedence over the item below it:

- `current working directory`
Expand Down Expand Up @@ -222,6 +220,10 @@ rules:
# include_note: false
```

A set of default rules is provided in [`pkg/rule/default.yaml`](https://github.com/get-woke/woke/blob/main/pkg/rule/default.yaml).

**NOTE: if you copy these rules into your config file, be sure to put them under the `rules:` key.**

#### Options

You can configure options for each rule. Add an `options` key to your rule definition to customize.
Expand Down

0 comments on commit eb3be5b

Please sign in to comment.