diff --git a/README.md b/README.md index f7d6b98..78c90b1 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,6 @@ and provides you with handy information about them. For the full description of this plugin, please refer to the ServerUtils [SpigotMC][spigot] page. -[![](https://jitpack.io/v/FrankHeijden/ServerUtils.svg)](https://jitpack.io/#FrankHeijden/ServerUtils) [![releaseImg]][release] [![GitHub Actions](https://github.com/FrankHeijden/ServerUtils/workflows/Java%20CI%20with%20Gradle/badge.svg)](https://github.com/FrankHeijden/ServerUtils/actions) [![licenseImg]][license] @@ -40,38 +39,55 @@ For the full description of this plugin, please refer to the ServerUtils [Spigot [![bStatsImg]][bStats] -## How to run the project? +## Compiling ServerUtils +There are two ways to compile ServerUtils: +### 1. Installing gradle (recommended) 1. Make sure you have [gradle][gradleInstall] installed. -2. Run the project with `gradle clean build` to compile all submodules with dependencies. -3. Afterwards, the platform specific plugins and platform independent compiled jars can be found in the `jars/` directory. +2. Run the project with `gradle build` to compile it with dependencies. +### 2. Using the wrapper +**Windows**: `gradlew.bat build` +
+**Linux/macOS**: `./gradlew build` + +## Developer API +### Repository / Dependency +If you wish to use snapshot versions of ServerUtils, you can use the following repo: +``` +https://repo.fvdh.dev/snapshots +``` -## API Repository / Dependency -Please use the following maven repository: #### Gradle: -```groovy -maven { url 'https://jitpack.io' } -``` -and as dependency: -```groovy -// Replace VERSION with for example 2.5.0 -compileOnly 'com.github.FrankHeijden:ServerUtils:VERSION' +```kotlin +repositories { + compileOnly("net.frankheijden.serverutils:ServerUtils:VERSION") +} + +dependencies { + maven("https://repo.fvdh.dev/releases") +} ``` + #### Maven: ```xml - - jitpack.io - https://jitpack.io - -``` -and as dependency: -```xml - - com.github.FrankHeijden - ServerUtils - - VERSION - provided - + + + + + fvdh + https://repo.fvdh.dev/releases + + + + + + + net.frankheijden.serverutils + ServerUtils + VERSION + provided + + + ``` ## Commands and Permissions