Skip to content

Commit

Permalink
docs: Add config options to README (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
DRBragg authored Nov 10, 2022
1 parent 0dbb4bc commit 17a6660
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,16 @@ class User < ApplicationRecord
end
```

### Configuration
Redaction has the following configuration options:
| Option | Default | Description |
|:------------|:------------|:------------|
| `email_domain` | `nil` | Set to a string to use a custom domain for redacted emails. i.e. `Redaction.config.email_domain = "my-domain.dev" |
| `progress_bar`| `true` | Set to false to not use the built in progress bar when redacting |
| `force_redaction` | `false` | Set to true to alway fill a column with redacted content even if the attribute is `nil` or empty |

It is reccomended that you put your configuration in an initializer like `config/initializers/redaction.rb`

## Roadmap
- [ ] Raise Error or at least a message when skipping a passed in Model
- [ ] Configuration (touch, email domains, etc)
Expand Down

0 comments on commit 17a6660

Please sign in to comment.