diff --git a/readme.md b/readme.md index adfd2da8..daedc6dd 100644 --- a/readme.md +++ b/readme.md @@ -10,135 +10,7 @@ Currently I'm not actively working on this project, but it's not abandoned! If y ## Dependency -
-Gradle (Kotlin-Script) -

- -**The repositories:** -```kotlin -jcenter() -mavenCentral() -maven("https://jitpack.io") -``` - -**The dependency:** - -```kotlin -implementation("net.axay", "KSpigot", "VERSION_HERE") -``` - -

-
- -
-Gradle (Groovy) -

- -**The repositories:** -```groovy -jcenter() -mavenCentral() -maven { url 'https://jitpack.io' } -``` - -**The dependency:** - -```groovy -implementation 'net.axay:KSpigot:VERSION_HERE' -``` - -

-
- -
-Maven -

- -**The repositories:** -```xml - - jcenter - jcenter - https://jcenter.bintray.com - - - jitpack.io - https://jitpack.io - -``` - -**The dependency:** -```xml - - net.axay - KSpigot - VERSION_HERE - -``` - -

-
- -If you work with KSpigot, you also need Spigot as a dependency. - -## Building your project - -
-Read before building your project! -

- -You **must** use a shade / shadow plugin with your build system. KSpigot needs to be relocated. - -#### GRADLE - -The plugin: -```kotlin -id("com.github.johnrengelman.shadow") version "6.0.0" -``` - -Now KSpigot needs to be relocated by using one of the following methods: - -

-Relocate only KSpigot -

- -Add the following to your buildscript: -```kotlin -tasks { - shadowJar { - relocate("net.axay.kspigot", "${project.group}.shadow.net.axay.kspigot") - } -} -``` - -

-
- -
-Relocate all of your dependencies -

- -Add the following to your buildscript: -```kotlin -val relocateShadowJar by tasks.creating(ConfigureShadowRelocation::class) { - target = tasks.shadowJar.get() - prefix = "${project.group}.shadow" -} - -tasks.shadowJar.get().dependsOn(relocateShadowJar) -``` - -

-
- -Now use the `shadowJar` task to build your project. - -#### MAVEN - -For example, you could use the [Apache Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/examples/class-relocation.html). - -

-
+Read the [guide](https://bluefireoly.gitbook.io/kspigot/) to get started! ## About