diff --git a/.idea/gradle.xml b/.idea/gradle.xml index 7b7dd5a..59c272e 100644 --- a/.idea/gradle.xml +++ b/.idea/gradle.xml @@ -1,5 +1,6 @@ + - - + + - - - - - diff --git a/README.md b/README.md index 13ece6b..fac4602 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,50 @@ # HSLDataConverter + +[![](https://jitpack.io/v/net.william278/HSLDataConverter.svg)](https://jitpack.io/#net.william278/HSLDataConverter) + A simple library to convert serialized legacy HuskSync (v1.x) data into Spigot API data. -This library is only for use in upgrading or converting HuskSync v1.x data in a portable manner and is utilised in HuskSync v2.x for data migration. +This library is only for use in upgrading or converting HuskSync v1.x data in a portable manner and is utilised in +HuskSync v2.x for data migration. + +## Including in your project + +Builds are available on [JitPack](https://jitpack.io/#net.william278/HSLDataConverter/). Include them in your pom.xml or +build.gradle file as per below. + +### Maven + +```xml + + jitpack + https://jitpack.io + +``` + +```xml + + + net.william278 + HSLDataConverter + 1.0.0 + +``` + +### Gradle + +```groovy +repositories { + maven { url 'https://jitpack.io' } +} +``` + +```groovy +dependencies { + implementation 'net.william278:HSLDataConverter:1.0.0' +} +``` ## Building -To build, simply run `./gradlew clean build` in the source root. Legacy HuskSync serialized classes are bundled and this resource does not depend on the HuskSync plugin itself. \ No newline at end of file + +To build, simply run `./gradlew clean build` in the source root. Legacy HuskSync serialized classes are bundled and this +resource does not depend on the HuskSync plugin itself. \ No newline at end of file diff --git a/jitpack.yml b/jitpack.yml new file mode 100644 index 0000000..8bb4a87 --- /dev/null +++ b/jitpack.yml @@ -0,0 +1,2 @@ +jdk: + - openjdk16 \ No newline at end of file