Skip to content

Commit

Permalink
Readme wording changes
Browse files Browse the repository at this point in the history
Co-authored-by: Jason Penilla <11360596+jpenilla@users.noreply.github.com>
  • Loading branch information
hjk321 and jpenilla authored Jun 20, 2024
1 parent 0c53b8f commit 7aca180
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 7aca180

Please sign in to comment.