Skip to content

Commit

Permalink
Add documentation re: available artifacts (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
twyatt authored Nov 26, 2024
1 parent 6cc9671 commit 65d80ab
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down Expand Up @@ -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()
}
}
```

0 comments on commit 65d80ab

Please sign in to comment.