Skip to content

Commit

Permalink
Update README and plugin descriptions for enhanced clarity
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
smyrgeorge committed Oct 19, 2024
1 parent a1aa04a commit d4f2921
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import org.gradle.kotlin.dsl.configure
class PublishConventions : Plugin<Project> {

private val descriptions: Map<String, String> = 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) {
Expand Down

0 comments on commit d4f2921

Please sign in to comment.