amalthea-mc/ShopChest
1
0
Fork 0
mirror of https://github.com/amalthea-mc/ShopChest.git synced 2024-11-22 10:22:29 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Eric 2016-07-04 17:44:18 +02:00 committed by GitHub
parent 031f0f99bc
commit 6608854377
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,6 +1,33 @@
# ShopChest # ShopChest
ShopChest - Spigot/Bukkit Plugin 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
<repositories>
<repository>
<id>shopchest-repo</id>
<url>https://epicericee.github.io/ShopChest/maven/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>de.epiceric</groupId>
<artifactId>ShopChest</artifactId>
<version>1.8.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
## 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 ## 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. 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.