Skip to content

Commit a480252

Browse files
committed
docs: update and cleanup the readme
1 parent 6788527 commit a480252

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,38 @@
11
# kotlin-multiplatform-diff
22

33
![Build and test](https://github.com/petertrr/kotlin-multiplatform-diff/workflows/Build%20and%20test/badge.svg)
4+
[![Codecov](https://codecov.io/gh/petertrr/kotlin-multiplatform-diff/branch/main/graph/badge.svg)](https://codecov.io/gh/petertrr/kotlin-multiplatform-diff)
45
[![License](https://img.shields.io/github/license/petertrr/kotlin-multiplatform-diff)](https://github.com/petertrr/kotlin-multiplatform-diff/blob/main/LICENSE)
5-
[![codecov](https://codecov.io/gh/petertrr/kotlin-multiplatform-diff/branch/main/graph/badge.svg)](https://codecov.io/gh/petertrr/kotlin-multiplatform-diff)
6-
7-
[![Releases](https://img.shields.io/github/v/release/petertrr/kotlin-multiplatform-diff)](https://github.com/petertrr/kotlin-multiplatform-diff/releases)
86
[![Maven Central](https://img.shields.io/maven-central/v/io.github.petertrr/kotlin-multiplatform-diff)](https://mvnrepository.com/artifact/io.github.petertrr)
97
[![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin)
8+
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.24-blue.svg?logo=kotlin)](http://kotlinlang.org)
109

1110
This is a port of [java-diff-utils](https://github.com/java-diff-utils/java-diff-utils) to Kotlin with multiplatform support.
12-
All credit for the implementation goes to original authors.
11+
All credit for the implementation goes to the original authors.
1312

1413
## Features
1514

16-
All features from version `4.12` of the original library are present, except for:
15+
All features from version `4.15` of the original library are present, except for:
1716

1817
- fuzzy patches
1918
- unified diff, which heavily uses file read/write and therefore needs a more complicated rewrite
2019
- diff-utils-jgit, which uses JVM-only JGit
2120

22-
Please refer to the original guides for more information.
23-
24-
## Supported Platforms
21+
Refer to the [original wiki][1] for more information.
2522

26-
Currently, artifacts for the following platforms are supported:
23+
## Supported platforms
2724

2825
- JVM
29-
- JS (both browser and Node.js)
30-
- WebAssembly (JS and WASI)
26+
- JS (browser and Node.js)
27+
- WebAssembly (WASM/JS and WASM/WASI)
3128
- Native
3229

33-
The supported Native targets are (following the Kotlin/Native [target support guidelines][1]):
30+
Supported Native targets are (following the Kotlin/Native [target support guidelines][2]):
3431

35-
| Tier 1 | Tier 2 | Tier 3 |
36-
|:------------------|:------------------|:---------|
37-
| macosX64 | linuxX64 | mingwX64 |
38-
| macosArm64 | linuxArm64 | |
32+
| Tier 1 | Tier 2 | Tier 3 |
33+
|:-----------|:-----------|:---------|
34+
| macosX64 | linuxX64 | mingwX64 |
35+
| macosArm64 | linuxArm64 | |
3936

40-
[1]: https://kotlinlang.org/docs/native-target-support.html
37+
[1]: https://github.com/java-diff-utils/java-diff-utils/wiki
38+
[2]: https://kotlinlang.org/docs/native-target-support.html

0 commit comments

Comments
 (0)