Skip to content

Commit 0cdda26

Browse files
committed
Update README
1 parent 69b6693 commit 0cdda26

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
Structured logging library for Kotlin, that aims to provide a developer-friendly API with minimal
44
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J.
55

6-
- Docs: [devlog-kotlin.hermannm.dev](https://devlog-kotlin.hermannm.dev)
7-
- Published on:
8-
- klibs.io:
9-
[klibs.io/project/hermannm/devlog-kotlin](https://klibs.io/project/hermannm/devlog-kotlin)
10-
- Maven Central:
11-
[central.sonatype.com/artifact/dev.hermannm/devlog-kotlin](https://central.sonatype.com/artifact/dev.hermannm/devlog-kotlin)
6+
**Docs:** [devlog-kotlin.hermannm.dev](https://devlog-kotlin.hermannm.dev)
7+
8+
**Published on:**
9+
10+
- klibs.io:
11+
[klibs.io/project/hermannm/devlog-kotlin](https://klibs.io/project/hermannm/devlog-kotlin)
12+
- Maven Central:
13+
[central.sonatype.com/artifact/dev.hermannm/devlog-kotlin](https://central.sonatype.com/artifact/dev.hermannm/devlog-kotlin)
1214

1315
**Contents:**
1416

@@ -20,7 +22,7 @@ runtime overhead. Currently only supports the JVM platform, wrapping SLF4J.
2022
- [Automatic logger names](#automatic-logger-names)
2123
- [Project Structure](#project-structure)
2224
- [Why another logging library?](#why-another-logging-library)
23-
- [Developer's guide](#developers-guide)
25+
- [Maintainer's guide](#maintainers-guide)
2426
- [Credits](#credits)
2527

2628
## Usage
@@ -372,9 +374,9 @@ improve with this library:
372374
provide `JsonContextFieldWriter` for interoperability with `MDC` when using Logback +
373375
`logstash-logback-encoder`.
374376

375-
## Developer's guide
377+
## Maintainer's guide
376378

377-
Updating dependencies:
379+
### Updating dependencies
378380

379381
- Run:
380382
```
@@ -383,18 +385,18 @@ Updating dependencies:
383385
- Also check for new versions of [`ktfmt`](https://github.com/facebook/ktfmt), and update the
384386
`ktfmt` entry under `spotless` in `build.gradle.kts`
385387

386-
Checking binary compatibility:
388+
### Checking binary compatibility
387389

388390
- We use the Kotlin
389391
[Binary Compatibility Validator](https://github.com/Kotlin/binary-compatibility-validator) to
390392
avoid accidental breaking changes
391-
- This plugin generates an `api/devlog-kotlin.api` file that contains all the public APIs of the
392-
library. When making changes to the library, any changes to the library's public API will be
393-
checked against this file (in the `apiCheck` Gradle task), to detect possible breaking changes
394-
- When _adding_ new APIs (which should not be a breaking change), you must update this `.api` file
395-
by running the `apiDump` Gradle task
393+
- This plugin generates an `api/devlog-kotlin.api` file that contains all the public APIs of the
394+
library. When making changes to the library, any changes to the library's public API will be
395+
checked against this file (in the `apiCheck` Gradle task), to detect possible breaking changes
396+
- When _adding_ new APIs (which should not be a breaking change), you must update this `.api` file
397+
by running the `apiDump` Gradle task
396398

397-
Publishing a new release:
399+
### Publishing a new release
398400

399401
- Run tests:
400402
```

0 commit comments

Comments
 (0)