Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation re: available artifacts #84

Merged
merged 4 commits into from
Nov 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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()
}
}
```