ShopChest-Updated/README.md

40 lines
1.3 KiB
Markdown
Raw Normal View History

2015-09-02 13:17:08 +02:00
# ShopChest
ShopChest - Spigot/Bukkit Plugin
2016-07-04 17:44:18 +02:00
## API
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>
2017-01-18 17:01:19 +01:00
<version>1.11.1</version>
2016-07-04 17:44:18 +02:00
<scope>provided</scope>
</dependency>
</dependencies>
```
2016-07-04 19:40:32 +02:00
You can find the javadoc here: https://epicericee.github.io/ShopChest/javadoc/
2016-07-04 17:44:18 +02:00
## Build
Clone this repository and use ``sh lib/install_local_depedencies.sh`` to import local dependencies.
After importation, use ``mvn clean package`` or ``mvn clean install`` to build the project.
After the build succeeded, the ShopChest.jar is found in the ``/plugin/target/`` folder.
2016-07-04 17:44:18 +02:00
2015-09-02 13:17:08 +02:00
## Issues
2016-08-05 15:33:42 +02:00
If you find any issues, please provide them in the [Issues Section](https://github.com/EpicEricEE/ShopChest/issues) with a good description of how to reproduce it. If you get any error messages in the console, please also provide them.
2015-09-02 13:17:08 +02:00
## Download
2017-01-18 17:01:19 +01:00
This resource/plugin is found on the official spigot page [here](https://www.spigotmc.org/resources/shopchest.11431/).
You can also download the latest unstable builds on [this page](https://ci.codemc.io/job/EpicEricEE/job/ShopChest/).
2017-01-18 17:01:19 +01:00