Skip to content

Commit 748b7c3

Browse files
committed
Update library description
1 parent d90d23e commit 748b7c3

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# devlog-kotlin
22

3-
Logging library for Kotlin JVM, that thinly wraps SLF4J and Logback to provide a more ergonomic API.
3+
Structured logging library for Kotlin, that aims to provide a developer-friendly API with near-zero
4+
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J and Logback.
45

56
- Docs: https://devlog-kotlin.hermannm.dev
67
- Published on:
@@ -118,6 +119,9 @@ fun example() {
118119
}
119120
```
120121

122+
For more detailed documentation of the classes and functions provided by the library, see
123+
<https://devlog-kotlin.hermannm.dev>.
124+
121125
## Adding to your project
122126

123127
Like SLF4J, `devlog-kotlin` only provides a logging _API_, and you have to add a logging
@@ -191,8 +195,8 @@ For more configuration options, see:
191195
## Implementation
192196

193197
- All the methods on `Logger` take a lambda argument to build the log, which is only called if the
194-
log level is enabled - so you only pay for log field serialization and message concatenation if
195-
it's actually logged.
198+
log level is enabled - so you only pay for message string concatenation and log field
199+
serialization if it's actually logged.
196200
- `Logger`'s methods are also `inline`, so we avoid the cost of allocating a function object for the
197201
lambda argument.
198202
- Elsewhere in the library, we use inline value classes when wrapping SLF4J/Logback APIs, to get as

build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ mavenPublishing {
1515
pom {
1616
name = "devlog-kotlin"
1717
description =
18-
"Logging library for Kotlin JVM, that thinly wraps SLF4J and Logback to provide a more ergonomic API."
18+
"Structured logging library for Kotlin, that aims to provide a developer-friendly API with near-zero runtime overhead."
1919
url = "https://devlog-kotlin.hermannm.dev"
2020
inceptionYear = "2024"
2121

gradle/dokka/module-docs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Module devlog-kotlin
22

3-
Logging library for Kotlin JVM, that thinly wraps SLF4J and Logback to provide a more ergonomic API.
3+
Structured logging library for Kotlin, that aims to provide a developer-friendly API with near-zero
4+
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J and Logback.
45

56
Repository: <https://github.com/hermannm/devlog-kotlin>
67

0 commit comments

Comments
 (0)