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 12, 2024
1 parent 086191e commit ee02483
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Serialize everything! **Night Auto Config** is a **[Night Config](https://github

**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`.

### Add to Your Project

It is recommended to use **[JitPack](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config)** to implement **Night Auto Config** into your project.

<details>
Expand All @@ -22,7 +24,7 @@ repositories {
}
dependencies {
modImplementation include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
modImplementation "com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version"
}
```

Expand All @@ -47,7 +49,6 @@ repositories {

dependencies {
modImplementation("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
}
```

Expand All @@ -62,6 +63,22 @@ 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.**
### Reference as Dependency

Don't forget to reference **Night Auto Config** as dependency in your mod's metadata.

<h6 align="right">fabric.mod.json / quilt.mod.json</h6>

```json
{
"depends": {
"nightautoconfig": "*"
}
}
```

</details>

## Usage

The serializer implementation is at [`band.kessokuteatime.nightautoconfig.config.NightConfigSerializer`](src/main/java/band/kessokuteatime/nightautoconfig/config/NightConfigSerializer.java).
Expand Down

0 comments on commit ee02483

Please sign in to comment.