From 57d40f18ef344c0c31eac614648d7caf0acbd092 Mon Sep 17 00:00:00 2001
From: Nikita Semenov <castlelecs@gmail.com>
Date: Thu, 29 Dec 2022 17:33:08 +0300
Subject: [PATCH] docs: added documentation to TILogging

---
 CHANGELOG.md        |  5 +++++
 TILogging/README.md | 24 ++++++++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 TILogging/README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6e303738..f797e135 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+### 1.30.1
+
+- **Fix**: `TILogging` bug with passing arguments to a logging message with wrapped `os_log` function;
+- **Added**: Documentation for `TILogging`.
+
 ### 1.30.0
 
 - **Added**: Base classes for encryption and decryption user token with pin code or biometry
diff --git a/TILogging/README.md b/TILogging/README.md
new file mode 100644
index 00000000..38750db9
--- /dev/null
+++ b/TILogging/README.md
@@ -0,0 +1,24 @@
+# TILogging
+
+## Logger usage
+
+```swift
+let logger = TILogger.defaultLogger
+
+// string interpolation
+logger.log(type: .default, "🐈 Hello from \(someName), I'm machine number \(someNumer)")
+
+// passing CVarArgs
+logger.log("🐈 Hello from %@, I'm machine number %i", type: .default, someName, someNumber)
+```
+
+To pass arguments to a logging string it is essantial to pass valid formatting specifiers
+
+| Specifier | Type | Usage |
+| --------- | ---- | ----- |
+| `%i`, `%d` | `Int` | `logger.verbose("🎉 int %i", 1)` |
+| `%f` | `Float` | `logger.verbose("🎉 float %f", Float(1.23))` |
+| `%f` | `Double` | `logger.verbose("🎉 double %f", Double(1.23))` |
+| `%@` | `String` | `logger.verbose("🎉 string %@", "String")` |
+
+> For more information about string format specifiers check the [documentation](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Strings/Articles/formatSpecifiers.html)