Improved README

This commit is contained in:
4drian3d 2021-11-15 18:09:07 -05:00
parent e670ed38c0
commit 234e25396c
2 changed files with 10 additions and 4 deletions

View File

@ -1,9 +1,9 @@
# AuthMeVelocity # AuthMeVelocity [![WorkFlow Status](https://img.shields.io/github/workflow/status/4drian3d/AuthmeVelocity/Maven%20Build?&style=flat-square)](https://github.com/4drian3d/AuthmeVelocity/actions/workflows/maven.yml) [![Version](https://img.shields.io/github/v/release/4drian3d/AuthmeVelocity?color=FFF0&style=flat-square)](https://github.com/4drian3d/AuthmeVelocity/releases)
This plugin adds the support for [Velocity](https://velocitypowered.com/) to [AuthMeReloaded](https://github.com/AuthMe/AuthMeReloaded) This plugin adds the support for [Velocity](https://velocitypowered.com/) to [AuthMeReloaded](https://github.com/AuthMe/AuthMeReloaded)
## Requirements ## Requirements
- Paper, Tuinity, Airplane or Purpur - Paper, Airplane or Purpur
- Velocity 3.0.0+ - Velocity 3.0.1+
- Java 16 - Java 16
## Setup ## Setup
@ -11,3 +11,9 @@ This plugin adds the support for [Velocity](https://velocitypowered.com/) to [Au
2. Put the jar that ends with "-proxy" in Velocity's plugins folder 2. Put the jar that ends with "-proxy" in Velocity's plugins folder
3. Put the jar that ends with "-spigot" in the Spigot servers that contains AuthMe 3. Put the jar that ends with "-spigot" in the Spigot servers that contains AuthMe
4. Start the Velocity proxy and set up the config.yml with the auth servers 4. Start the Velocity proxy and set up the config.yml with the auth servers
# Plugin API
Check the plugin API [here](https://github.com/4drian3d/AuthMeVelocity/wiki/Plugin-API)
# Configuration
Check the plugin configuration [here](https://github.com/4drian3d/AuthMeVelocity/wiki/Configuration)