From fbda536a0a5d0934c1ee0bc766d39ad91b2ebe46 Mon Sep 17 00:00:00 2001 From: Eric Date: Sun, 21 Aug 2022 00:05:52 +0200 Subject: [PATCH] Update README.md --- README.md | 39 +++------------------------------------ 1 file changed, 3 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index dc82a2e..27b7a86 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,5 @@ # ShopChest -ShopChest - Spigot/Bukkit Plugin - -## API -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.11.1 - provided - - -``` - -You can find the javadoc here: https://epicericee.github.io/ShopChest/javadoc/ - -## Build -Clone this repository and use ``mvn clean package`` or ``mvn clean install``. -After the build succeeded, the ShopChest.jar is found in the ``/target/`` folder. - -## Issues -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. - - -## Download -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](http://epiceric.square7.de/bukkit/plugins/). +## What is this branch? +In August 2019, I began working on a full rewrite of this plugin with the goal of making a proper API and just a generally better structured project. However, I never published my progress, so after I eventually stopped working on it in March 2020, this has been lying around for over two years. The last couple commits with a more recent date (2022) were made from uncomitted changes I made back then. I also still have some changes stashed, but they aren't really compatible with the current code and would require some work to solve all the merge conflicts, so I didn't commit them. +I'm not sure if I'll ever get around to continue working on this, but I thought I'd share it with you all :)