Update README.md

github · Nov 14, 2023 · fc7298c · fc7298c
1 parent 388ec6c
commit fc7298c
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,26 @@ gem "redacting-logger", "~> X.X.X" # Replace X.X.X with the latest version
 
 ## Usage 💻
 
+### Basic
+
+```ruby
+require "redacting_logger"
+
+# Create a new logger
+logger = RedactingLogger.new(redact_patterns: [/topsecret/])
+
+# Log a message that contains some redacted pattern
+logger.info("This is a topsecret message.")
+```
+
+This will output:
+
+```text
+I, [timestamp]  INFO -- : This is a [REDACTED] message.
+```
+
+### Advanced
+
 ```ruby
 require "redacting_logger"