From 8ce0d22c61f00fcbc17296e5f51cada875f017d3 Mon Sep 17 00:00:00 2001 From: Triassic Date: Thu, 13 Jul 2023 20:02:41 +0300 Subject: [PATCH] chore: add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc5fe6a --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# ReturnMe +An addon for AuthMe, for Bungeecord, that saves the last server the player was on and then reconnects them to it once the player logs back onto the server and logs in. + +## How to use? +1. Download the [latest release](https://github.com/RealTriassic/ReturnMe/releases/latest) of the plugin. +2. Put the `.jar` file into your `plugins` directory **of your Bungeecord server** +3. Restart your server. +4. Head to `plugins/ReturnMe/config.yml` and configure the plugin to your liking! +5. Once you're done configuring, restart your server again! + +## Compiling yourself +1. Open a Terminal +2. Use `git clone https://github.com/RealTriassic/ReturnMe.git` to clone this repository. +3. Run `mvn clean package`. +4. Compiled JAR should be available in the `target` directory. + +## Issues +If you run into an issue whilst using my plugin, feel free to open an issue and please explain the issue you're experiencing thoroughly with reproduction steps. +**Make sure to attach your config.yml alongside your report and a stacktrace of the error, if any.** + +## License +This project is licensed under the MIT License, you may view the LICENSE [here](https://github.com/RealTriassic/ReturnMe/blob/main/LICENSE).