Merge pull request 'Add Documentation' (#2) from add_documentation into main

Reviewed-on: #2

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Marvin Elsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# CC-CEDICT Parser for Kotlin
+
+A parser for the [CC-CEDICT](https://www.mdbg.net/chinese/dictionary?page=cedict) Chinese-to-English dictionary written
+in [Kotlin](https://kotlinlang.org).
+
+## Installation
+
+_CC-CEDICT Parser for Kotlin_ is available
+from [my self-hosted Gitea instance](https://gitea.marvinelsen.com/marvinelsen/cedict-parser).
+
+First, add the repository to your `build.gradle.kts` file:
+
+```kotlin
+repositories {
+    maven {
+        url = uri("https://gitea.marvinelsen.com/api/packages/marvinelsen/maven")
+    }
+}
+```
+
+Afterwards, add the package dependency to your `build.gradle.kts` file:
+
+```kotlin
+dependencies {
+    implementation("com.marvinelsen:cedict-parser:1.0-SNAPSHOT")
+}
+```
+
+## Usage
+
+```kotlin
+fun main() {
+    val cedictInputStream =
+        GZIPInputStream(object {}.javaClass.getResourceAsStream("/cedict_1_0_ts_utf-8_mdbg.txt.gz")!!)
+
+    val cedictParser = CedictParser.instance
+    val cedictEntries = cedictParser.parseCedict(cedictInputStream)
+
+    for (entry in cedictEntries) {
+        println(entry.traditional)
+        println(entry.simplified)
+        println(entry.pinyinSyllables.joinToString(" "))
+        println(entry.definitions.joinToString("/") { it.glosses.joinToString(";") })
+    }
+}
+```
+
+## License
+
+All source code in this repository is licensed under a [MIT license](LICENSE), unless otherwise noted.
+
+To the following third-party code, data, and files in the repository different licenses apply:
+
+### CC-CEDICT
+
+[CC-CEDICT](https://cc-cedict.org/wiki) is licensed under
+a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).