From 7aca1800edd3eb7a6d41f33ceeaccdfe07236e4c Mon Sep 17 00:00:00 2001 From: Hiram Anderson <37224753+hjk321@users.noreply.github.com> Date: Thu, 20 Jun 2024 00:40:36 -0600 Subject: [PATCH] Readme wording changes Co-authored-by: Jason Penilla <11360596+jpenilla@users.noreply.github.com> --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6af4ad3..a9c3c51 100644 --- a/README.md +++ b/README.md @@ -12,27 +12,27 @@ and do not support the legacy plugin system Paper Trail offers a simple way to notify users that they need to upgrade to Paper by providing a stub `JavaPlugin` that prints a helpful message -on startup then disables itself. +on startup and then disables itself. An alternate message is used if the server is running Paper, but the version is too old to support the Paper plugin system. ### How to Use -Add the PaperMC repository to your build script +Add the PaperMC repository (`https://repo.papermc.io/repository/maven-public/`) to your build script and shade `io.papermc:paper-trail:0.0.1-SNAPSHOT` into your plugin. -It is recommended to relocate this dependency's +It is recommended to relocate the `io.papermc.papertrail` package to avoid conflicts. -To use Paper Trail, create a dummy -`plugin.yml` in your plugin with +To use Paper Trail, add a +`plugin.yml` to your plugin with `io.papermc.papertrail.RequiresPaperPlugins` as the "main" class. If you relocated the package, be sure to adjust -the class path in the yml accordingly. +the class name in the yaml accordingly. ### License Paper Trail is licensed under the MIT License. -See the LICENSE file for more information. +See the [LICENSE](LICENSE) file for more information.