diff --git a/README.md b/README.md index 065deb4..de47c8e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -###

[`→` CurseForge](https://www.curseforge.com/minecraft/mc-mods/night-auto-config) [`→` Modrinth](https://modrinth.com/mod/night-auto-config)

+###

[`→` JitPack](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config) [`→` CurseForge](https://www.curseforge.com/minecraft/mc-mods/night-auto-config) [`→` Modrinth](https://modrinth.com/mod/night-auto-config)

# Night Auto Config Serialize everything! **Night Auto Config** is a **[Night Config](https://github.com/TheElectronWill/Night-Config)** integration for **[Auto Config (now embedded in Cloth Config).](https://modrinth.com/mod/cloth-config)** +## Implementation + **Night Auto Config** introduces a `NightConfigSerializer` to satisfy **Auto Config**'s requirement of a serializer's implementation. You can choose from all the available config formats of **Night Config,** and use the serializer just as other common serializers, even along with a `PartitioningSerializer`. -It is recommended to use [`JitPack`](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config/1.0.0-fabric1.21) to implement **Night Auto Config** into your project. +It is recommended to use **[JitPack](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config)** to implement **Night Auto Config** into your project.
@@ -20,7 +22,7 @@ repositories { } dependencies { - implementation include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version") + modImplementation include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version") } ``` @@ -44,7 +46,7 @@ repositories { } dependencies { - implementation("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version") + modImplementation("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version") include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version") } ``` @@ -60,6 +62,8 @@ nightautoconfig_version={latest} > [!NOTE] > You should replace `{latest}` with the latest [`tag name`](https://github.com/KessokuTeaTime/Night-Auto-Config/tags) of **Night Auto Config.** +## Usage + Here's a brief example: `MyConfig.java`