From 70d9c6e0d1140e8a66cc20b5936b506e480c8c1a Mon Sep 17 00:00:00 2001
From: Michael Liao <mikeliao@amazon.com>
Date: Tue, 15 Oct 2024 18:37:06 -0700
Subject: [PATCH] Update README.md to include SDKLogger

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index d07e0d0..0889f5d 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@
   * [GlobalConfig](#globalconfig)
     * [GlobalConfig.init](#globalconfiginit)
     * [Updating configuration](#updating-configuration)
+  * [SDKLogger](#sdklogger)
   * [ChatSession APIs](#chatsession-apis)
   * [ChatSession Events](#chatsession-events)
   * [Classes and Structs](#classes-and-structs)
@@ -138,6 +139,41 @@ let globalConfig = GlobalConfig(region: .USEast1)
 chatSession.configure(config: globalConfig)
 ```
 
+### SDKLogger
+The `SDKLogger` class is responsible for logging relevant runtime information to the console which is useful for debugging purposes. The `SDKLogger` will log key events such as establishing a connection or failures such as failing to send a message.
+
+#### `SDKLogger.configure`
+This API will allow you to override the SDK's built-in logger with your own [SDKLoggerProtocol](#sdkloggerprotocol) implementation. This is especially useful in cases where you would want to store logs for debugging purposes. Attaching these logs to issues filed in this project will greatly expedite the resolution process.
+
+```
+public static func configureLogger(_ logger: SDKLoggerProtocol) {
+    SDKLogger.logger = logger
+}
+```
+
+#### SDKLoggerProtocol
+The SDKLoggerProtocol is a protocol used for the `SDKLogger`.  Users can override the `SDKLogger` with any class that implements SDKLoggerProtocol.
+
+```
+public protocol SDKLoggerProtocol {
+    func logVerbose(
+        _ message: @autoclosure () -> String
+    )
+    func logInfo(
+        _ message: @autoclosure () -> String
+    )
+    func logDebug(
+        _ message: @autoclosure () -> String
+    )
+    func logFault(
+        _ message: @autoclosure () -> String
+    )
+    func logError(
+        _ message: @autoclosure () -> String
+    )
+}
+```
+
 --------------------
 
 ### ChatSession APIs