Skip to content

Commit e417a7b

Browse files
committed
feat(docs): Add modules section to README with descriptions and coordinates for core, bindings, and OOP modules.
1 parent c0b5c03 commit e417a7b

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,18 @@ kotlin {
6868
Then create a `Main.kt` file and start writing your datapacks. See the [documentation](https://kore.ayfri.com/docs/home) for more
6969
information.
7070

71+
## Modules
72+
73+
- [**Kore (core DSL)**](https://github.com/Ayfri/Kore/tree/main/kore)
74+
- The core module with the DSL to create Minecraft datapacks.
75+
- Coordinates: `io.github.ayfri.kore:kore:VERSION`
76+
- [**Bindings (experimental importer)**](https://github.com/Ayfri/Kore/tree/main/bindings)
77+
- Imports existing datapacks and generates type-safe Kotlin bindings.
78+
- Coordinates: `io.github.ayfri.kore:bindings:VERSION`
79+
- [**OOP (experimental)**](https://github.com/Ayfri/Kore/tree/main/oop)
80+
- An experimental module to write Minecraft datapacks with Object-Oriented Programming concepts.
81+
- Coordinates: `io.github.ayfri.kore:oop:VERSION`
82+
7183
## Example
7284

7385
```kotlin

bindings/build.gradle.kts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
plugins {
22
kotlin("jvm")
33
kotlin("plugin.serialization")
4+
`publish-conventions`
5+
}
6+
7+
metadata {
8+
name = "Kore Bindings"
9+
description = "Imports existing Minecraft datapacks and generates type-safe Kotlin bindings."
410
}
511

612
repositories {
@@ -18,11 +24,11 @@ kotlin {
1824

1925
dependencies {
2026
implementation(libs.kotlinpoet)
21-
testImplementation(libs.kotlinx.io)
2227
implementation(libs.kotlinx.serialization)
2328
implementation(project(":kore"))
2429

2530
testImplementation(libs.kotlin.dotenv)
31+
testImplementation(libs.kotlinx.io)
2632
}
2733

2834

0 commit comments

Comments
 (0)