From 0c82d79347ba91baa992396902b5e41591c2f5fd Mon Sep 17 00:00:00 2001 From: oshai Date: Sat, 29 Oct 2022 20:52:02 +0300 Subject: [PATCH] reword slf4j usage for #229 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2303fbbc..b6a675d8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # kotlin-logging [kotlin-logging](https://github.com/MicroUtils/kotlin-logging) [![CI](https://github.com/MicroUtils/kotlin-logging/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/MicroUtils/kotlin-logging/actions/workflows/ci.yml) [![Slack channel](https://img.shields.io/badge/Chat-Slack-blue.svg)](https://kotlinlang.slack.com/messages/kotlin-logging/) [![Maven Central](https://img.shields.io/maven-central/v/io.github.microutils/kotlin-logging.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.github.microutils%22) [![Apache License V.2](https://img.shields.io/badge/license-Apache%20V.2-blue.svg)](https://github.com/MicroUtils/kotlin-logging/blob/master/LICENSE) Lightweight logging framework for Kotlin, written in [![Pure Kotlin](https://img.shields.io/badge/100%25-kotlin-blue.svg)](https://kotlinlang.org/). -A convenient and performant logging library wrapping [slf4j](http://www.slf4j.org/) with Kotlin extensions. +A convenient and performant logging facade. +For jvm `kotlin-logging` is wrapping [slf4j](http://www.slf4j.org/) with Kotlin extensions. +For other platforms `kotlin-logging` has various implementations. More details in the [wiki](https://github.com/MicroUtils/kotlin-logging/wiki/Multiplatform-support) #### Call log methods, without checking whether the respective log level is enabled ```Kotlin @@ -14,7 +16,7 @@ Behind the scenes the expensive message do not get evaluated if debug is not ena if (logger.isDebugEnabled) logger.debug("Some $expensive message!") ``` -#### Define the logger, without explicitly specifiying the class name +#### Define the logger, without explicitly specifying the class name ```Kotlin // Place definition above class declaration to make field static private val logger = KotlinLogging.logger {}