From d4f2921a293f1d39132023431c92abeaf8c092de Mon Sep 17 00:00:00 2001 From: George Smyrnaios Date: Sat, 19 Oct 2024 11:55:07 +0200 Subject: [PATCH] Update README and plugin descriptions for enhanced clarity Revised the README to provide a clearer, more comprehensive overview of the project's logging and tracing capabilities for Kotlin Multiplatform. Also updated the plugin description to align with the new messaging. --- README.md | 15 +++++++-------- .../log4k/publish/PublishConventions.kt | 2 +- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b2428790..0f406801 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,11 @@ ![GitHub issues](https://img.shields.io/github/issues/smyrgeorge/log4k) [![Kotlin](https://img.shields.io/badge/kotlin-2.0.21-blue.svg?logo=kotlin)](http://kotlinlang.org) -The missing logger for Kotlin Multiplatform. +A Comprehensive Logging and Tracing Solution for Kotlin Multiplatform. -This project aims to develop a logger designed for Kotlin Multiplatform -that operates asynchronously and is event-driven at its core. -Built from the ground up, log4k leverages Kotlin’s coroutines -and channels to deliver efficient and scalable logging. +This project provides a robust, event-driven logging and tracing platform specifically designed for Kotlin +Multiplatform (also compatible with the Java ecosystem). Built with coroutines and channels at its core, it offers +asynchronous, scalable logging across multiple platforms. > [!IMPORTANT] > The project is in a very early stage; thus, breaking changes should be expected. @@ -23,9 +22,9 @@ and channels to deliver efficient and scalable logging. ## TODO -- [ ] Introduce tracing API (event/span) -- [ ] `CoroutineContexAwareLogger`: `Logger` that will collect more info from the coroutine context. (in progress) -- [ ] Ability to chain appenders (in progress) +- [ ] Introduce tracing API (in progress) +- [ ] `CoroutineContexAwareLogger`: `Logger` that will collect more info from the coroutine context. +- [ ] Ability to chain appenders - [ ] Json console logger - [ ] `LogbackAppender`: `Appender` that will publish the logging events to the logback. diff --git a/build-logic/plugins/src/main/kotlin/io/github/smyrgeorge/log4k/publish/PublishConventions.kt b/build-logic/plugins/src/main/kotlin/io/github/smyrgeorge/log4k/publish/PublishConventions.kt index 7eab7820..e89a8103 100644 --- a/build-logic/plugins/src/main/kotlin/io/github/smyrgeorge/log4k/publish/PublishConventions.kt +++ b/build-logic/plugins/src/main/kotlin/io/github/smyrgeorge/log4k/publish/PublishConventions.kt @@ -9,7 +9,7 @@ import org.gradle.kotlin.dsl.configure class PublishConventions : Plugin { private val descriptions: Map = mapOf( - "log4k" to "The missing logger for Kotlin Multiplatform.", + "log4k" to "A Comprehensive Logging and Tracing Solution for Kotlin Multiplatform.", ) override fun apply(project: Project) {