Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GrantBirki committed Nov 13, 2023
1 parent 792dc31 commit 520124d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,20 @@ This will output:
```text
I, [timestamp] INFO -- : This is a message with a [REDACTED] and [REDACTED] in it.
```

## Default Redaction Patterns

This Gem comes pre-built with a few redaction patterns to help you get started. These patterns can be located in [`lib/patterns/default.rb`](lib/patterns/default.rb)

A few examples of these patterns are:

- GitHub Personal Access Tokens
- GitHub Temporary Actions Tokens

You can disable these default patterns with:

```ruby
logger = RedactingLogger.new(
use_default_patterns: false # Whether to use the default built-in patterns or not
)
```

0 comments on commit 520124d

Please sign in to comment.