diff --git a/README.md b/README.md index b902169..3f55931 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,14 @@ Simple and robust Kotlin Multiplatform logging. +### Setup (Gradle) + +Add the core Khronicle dependency in your Gradle configuration: + +```kotlin +implementation("com.juul.khronicle:khronicle-core:$version") +``` + ### Initialization Logging can be initialized via `install`: @@ -126,3 +134,15 @@ Log.warn { metadata -> "This is also evaluated, and does print to the console." } ``` + +### Ktor + +A basic `KtorLogger` is available via the `com.juul.khronicle:khronicle-ktor-client:$version` artifact: + +```kotlin +HttpClient { + install(Logging) { + logger = KhronicleKtorClientLogger() + } +} +```