From 520124d1f9c5fbe1245c2ec5e619eff190e3e678 Mon Sep 17 00:00:00 2001 From: GrantBirki Date: Mon, 13 Nov 2023 14:22:08 -0700 Subject: [PATCH] update docs --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 8664dfa..f2bfac1 100644 --- a/README.md +++ b/README.md @@ -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 +) +```