From 3dee74c23c23909fcb4eb8da7d08662edb5b162a Mon Sep 17 00:00:00 2001 From: Nassim Jahnke Date: Tue, 10 Dec 2024 10:06:17 +0100 Subject: [PATCH] Update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 891cd17..a8b2a33 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,26 @@ Replaces mcstruct's inbuilt nbt library with ViaNBT. ## Setup + ```bash git submodule update --init ``` Then you can run the Python script to apply the automated updates. + ```bash py mcstructs.py cd MCStructs gradlew test -x checkstyleMain -``` \ No newline at end of file +``` + +## Dependency + +We wouldn't necessarily recommend depending on this given the hacky replacements +and specific needs, but this is published to our maven repository at: https://repo.viaversion.com + +```kotlin +implementation("com.viaversion.mcstructs:text:5-") +``` + +The prefix is the current major version of ViaVersion, followed by the mcstructs version. \ No newline at end of file