Prepare for release

Wavesonics · Dec 5, 2024 · 3db5fd9 · 3db5fd9
1 parent e13b66f
commit 3db5fd9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/Fdic/src/jvmTest/kotlin/performance/PerformanceTests.kt b/Fdic/src/jvmTest/kotlin/performance/PerformanceTests.kt
@@ -2,12 +2,10 @@ package performance
 
 import com.darkrockstudios.fdic.FrequencyDictionary
 import com.darkrockstudios.fdic.FrequencyDictionaryIO
-import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.test.runTest
 import okio.FileSystem
 import okio.Path.Companion.toPath
 import okio.buffer
-import org.junit.Before
 import org.junit.Test
 import performance.strategies.fdicGzFile
 import performance.strategies.loadGzDict

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ algorithm. It has been ported from this [Java implementation](https://github.com
 
 ## Dependency
 
-`implementation("com.darkrockstudios:symspellkt:2.1.1")`
+`implementation("com.darkrockstudios:symspellkt:3.1.0")`
 
 ## Sample
 
@@ -41,6 +41,17 @@ Try out the sample desktop application:
   inserts of the input term are transformed into deletes of the dictionary term.
 * The speed comes from the inexpensive delete-only edit candidate generation and the pre-calculation.
 
+## Fdic: Binary Frequency Dictionary file format
+
+In order to optimize for size on disk, and speed of loading and parsing, I made a little file format to encode the
+common plain text frequency dictionaries use with SymSpell style spell checkers.
+
+[fdic](Fdic/README.md) is both smaller on disk, and faster to load than either plain text or gzipped dictionaries. In some cases being
+ 70% faster to load and parse, and more than 40% smaller on disk.
+
+There is a [CLI program](FdicCli/README.md) for producing `.fdic` files from a standard plain text frequency dictionary, as well as some 
+extension functions in an [addon library](SymSpellKtFdic/README.md) for loading them into a SymSpellKt SpellChecker object.
+
 [badge-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
 [badge-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat
 [badge-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat

diff --git a/convention-plugins/src/main/kotlin/root.publication.gradle.kts b/convention-plugins/src/main/kotlin/root.publication.gradle.kts
@@ -4,7 +4,7 @@ plugins {
 
 allprojects {
 	group = "com.darkrockstudios"
-	version = "3.0.9"
+	version = "3.1.0"
 }
 
 nexusPublishing {