Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KrLite authored Jul 10, 2024
1 parent ed197bd commit 18155c6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

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.
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit 18155c6

Please sign in to comment.