update docs and deps

Author: aallam

CHANGELOG.md

@@ -0,0 +1,19 @@
+# 0.1.0
+> Published 09 Mar 2023
+
+### Added
+
+* Levenshtein
+* Normalized Levenshtein
+* Weighted Levenshtein
+* Damerau-Levenshtein
+* Optimal String Alignment
+* Jaro-Winkler
+* Longest Common Subsequence
+* Metric Longest Common Subsequence
+* N-Gram
+* Q-Gram
+* Cosine similarity
+* Jaccard index
+* Sorensen-Dice coefficient
+* Ratcliff-Obershelp

README.md

@@ -2,6 +2,7 @@
 
 [![Maven Central](https://img.shields.io/maven-central/v/com.aallam.similarity/string-similarity-kotlin?color=blue&label=Download)](https://search.maven.org/artifact/com.aallam.similarity/string-similarity-kotlin)
 [![License](https://img.shields.io/github/license/aallam/string-similarity-kotlin?color=yellow)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-dokka-a97bff)](https://mouaad.aallam.com/string-similarity-kotlin/)
 
 This is a library that implements various measures of string similarity and distance.
 
@@ -27,20 +28,20 @@ dependencies {
 
 The following is the list of implemented algorithms:
 
-* [Levenshtein](docs/Levenshtein.md)
-* [Normalized Levenshtein](docs/NormalizedLevenshtein.md)
-* [Weighted Levenshtein](docs/WeightedLevenshtein.md)
-* [Damerau-Levenshtein](docs/DamerauLevenshtein.md)
-* [Optimal String Alignment](docs/OptimalStringAlignment.md)
-* [Jaro-Winkler](docs/JaroWinkler.md)
-* [Longest Common Subsequence](docs/LCS.md)
-* [Metric Longest Common Subsequence](docs/MetricLCS.md)
-* [N-Gram](docs/NGram.md)
-* [Q-Gram](docs/QGram.md)
-* [Cosine similarity](docs/CosineSimilarity.md)
-* [Jaccard index](docs/JaccardIndex.md)
-* [Sorensen-Dice coefficient](docs/SorensenDiceCoefficient.md)
-* [Ratcliff-Obershelp](docs/RatcliffObershelp.md)
+* [Levenshtein](guides/Levenshtein.md)
+* [Normalized Levenshtein](guides/NormalizedLevenshtein.md)
+* [Weighted Levenshtein](guides/WeightedLevenshtein.md)
+* [Damerau-Levenshtein](guides/DamerauLevenshtein.md)
+* [Optimal String Alignment](guides/OptimalStringAlignment.md)
+* [Jaro-Winkler](guides/JaroWinkler.md)
+* [Longest Common Subsequence](guides/LCS.md)
+* [Metric Longest Common Subsequence](guides/MetricLCS.md)
+* [N-Gram](guides/NGram.md)
+* [Q-Gram](guides/QGram.md)
+* [Cosine similarity](guides/CosineSimilarity.md)
+* [Jaccard index](guides/JaccardIndex.md)
+* [Sorensen-Dice coefficient](guides/SorensenDiceCoefficient.md)
+* [Ratcliff-Obershelp](guides/RatcliffObershelp.md)
 
 ## Prior-Art
 

gradle/libs.versions.toml

@@ -1,19 +1,16 @@
 [versions]
 kotlin = "1.8.10"
-resources = "0.2.4"
 
 [libraries]
 # Kotlin
 kotlin-test-common = { module = "org.jetbrains.kotlin:kotlin-test-common" }
 kotlin-test-annotations-common = { module = "org.jetbrains.kotlin:kotlin-test-annotations-common" }
 kotlin-test-junit = { module = "org.jetbrains.kotlin:kotlin-test-junit" }
 kotlin-test-js = { module = "org.jetbrains.kotlin:kotlin-test-js" }
-resources = { module = "com.goncalossilva:resources", version.ref = "resources"}
 
 [plugins]
 kotlin-multiplaform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
-kotlinx-binary-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version = "0.12.1" }
-maven-publish = { id = "com.vanniktech.maven.publish", version = "0.23.1" }
-spotless = { id = "com.diffplug.gradle.spotless", version = "6.12.1" }
+kotlinx-binary-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version = "0.13.0" }
+maven-publish = { id = "com.vanniktech.maven.publish", version = "0.24.0" }
+spotless = { id = "com.diffplug.gradle.spotless", version = "6.16.0" }
 dokka = { id = "org.jetbrains.dokka", version = "1.8.10" }
-resources = { id = "com.goncalossilva.resources", version.ref = "resources" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists