zhdev/bukman
1
0
Fork 0
Code Issues Pull requests Releases 1 Activity

Update README.md with new repo

Browse source
This commit is contained in:
Frank van der Heijden 2021-10-05 16:49:03 +02:00
parent 75c2fda749
commit 529d8a35ad
No known key found for this signature in database
GPG key ID: B808721C2DD5B5B8
1 changed files with 43 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -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`
<br>
**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
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
```
and as dependency:
```xml
<dependency>
<groupId>com.github.FrankHeijden</groupId>
<artifactId>ServerUtils</artifactId>
<!-- Replace VERSION with for example 2.5.0 -->
<version>VERSION</version>
<scope>provided</scope>
</dependency>
<project>
<repositories>
<!-- Insights repo -->
<repository>
<id>fvdh</id>
<url>https://repo.fvdh.dev/releases</url>
</repository>
</repositories>
<dependencies>
<!-- Insights dependency -->
<dependency>
<groupId>net.frankheijden.serverutils</groupId>
<artifactId>ServerUtils</artifactId>
<version>VERSION</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>
```
## Commands and Permissions