chinese-transliteration/README.md

38 lines
828 B
Markdown
Raw Permalink Normal View History

2024-09-20 10:35:42 +00:00
# Chinese Transliteration for Kotlin
A Chinese transliteration library written in [Kotlin](https://kotlinlang.org).
## Installation
_Chinese Transliteration for Kotlin_ is available
from [my self-hosted Gitea instance](https://gitea.marvinelsen.com/marvinelsen/chinese-transliteration).
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:chinese-transliteration:1.0-SNAPSHOT")
}
```
## Usage
```kotlin
fun main() {
TODO()
}
```
## License
All source code in this repository is licensed under a [MIT license](LICENSE), unless otherwise noted.