diff --git a/README.md b/README.md index 6af0a75..ba99dd6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,51 @@ + +[spigot]: https://www.spigotmc.org/resources/79599/ +[spigotRatingImg]: https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=rating&query=%24.rating.average&suffix=%20%2F%205&url=https%3A%2F%2Fapi.spiget.org%2Fv2%2Fresources%2F79599 +[spigotDownloadsImg]: https://img.shields.io/badge/dynamic/json.svg?color=brightgreen&label=downloads%20%28spigotmc.org%29&query=%24.downloads&url=https%3A%2F%2Fapi.spiget.org%2Fv2%2Fresources%2F79599 +[issues]: https://github.com/FrankHeijden/ServerUtils/issues +[wiki]: https://github.com/FrankHeijden/ServerUtils/wiki +[release]: https://github.com/FrankHeijden/ServerUtils/releases/latest +[releaseImg]: https://img.shields.io/github/release/FrankHeijden/ServerUtils.svg?label=github%20release +[license]: https://github.com/FrankHeijden/ServerUtils/blob/master/LICENSE +[licenseImg]: https://img.shields.io/github/license/FrankHeijden/ServerUtils.svg +[bugReports]: https://github.com/FrankHeijden/ServerUtils/issues?q=is%3Aissue+is%3Aopen+label%3Abug +[bugReportsImg]: https://img.shields.io/github/issues/FrankHeijden/ServerUtils/bug.svg?label=bug%20reports +[reportBug]: https://github.com/FrankHeijden/ServerUtils/issues/new?labels=bug&template=bug.md +[featureRequests]: https://github.com/FrankHeijden/ServerUtils/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement +[featureRequestsImg]: https://img.shields.io/github/issues/FrankHeijden/ServerUtils/enhancement.svg?label=feature%20requests&color=informational +[requestFeature]: https://github.com/FrankHeijden/ServerUtils/issues/new?labels=enhancement&template=feature.md +[gradleInstall]: https://gradle.org/install/ +[bStatsImg]: https://bstats.org/signatures/bukkit/ServerUtils.svg +[bStats]: https://bstats.org/plugin/bukkit/ServerUtils/7790 + + # ServerUtils ServerUtils allows you to manage your plugins in-game. Featuring reloading, unloading and loading of plugins from your plugins folder at runtime. ServerUtils also has handy methods to lookup commands and plugins, 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] +[![licenseImg]][license] +[![featureRequestsImg]][featureRequests] +[![bugReportsImg]][bugReports] +[![spigotRatingImg]][spigot] +[![spigotDownloadsImg]][spigot] + +[![Discord](https://img.shields.io/discord/580773821745725452.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/WJGvzue) + +[![bStatsImg]][bStats] + +## How to run the project? +1. Make sure you have [gradle][gradleInstall] installed. +2. Run the project with `gradle build` to compile all submodules with dependencies. +3. The platform specific plugins are located at + `/build/libs/ServerUtils---all.jar`. + The global platform independent plugin which will run on all platforms can be found at + `build/libs/ServerUtils--all.jar`. + +## Commands and Permissions +Please refer to the [SpigotMC][spigot] page for an updated overview of the commands and permissions.