From 66088543770d8e03be78ef27b318ce1275bab014 Mon Sep 17 00:00:00 2001 From: Eric Date: Mon, 4 Jul 2016 17:44:18 +0200 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index c638595..8aef7c4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ # ShopChest ShopChest - Spigot/Bukkit Plugin +## API +_An official API will be available soon_ + +To use the API, you need to add the following repository and dependency in your maven project: + +```xml + + + shopchest-repo + https://epicericee.github.io/ShopChest/maven/ + + + + + + de.epiceric + ShopChest + 1.8.0 + provided + + +``` + +## Build +Clone this repository and use ``mvn clean package`` or ``mvn clean install``. +After the build succeeded, the ShopChest.jar is found in ``/ShopChest/target/``. + ## Issues If you find any issues, please provide them in the Issues Section with a good description of how to reproduce it. If you get any error messages in the console, please also provide them.