Changed Nukkit to Spigot

README.md

@@ -1,2 +1,41 @@
-# KygekPingTPS-Spigot
-Up-and-coming Java Edition version of KygekPingTPS by DavidDGTNT
+### NOTICE: This is the Spigot (Java Edtion) version of KygekPingTPS. Please see [here](https://github.com/KygekTeam/KygekPingTPS) for PocketMine-MP version.
+
+# KygekPingTPS
+
+A plugin to check the server TPS and other players' ping. This plugin will be useful if you need to check the server TPS by command or check your or other players' network ping.
+
+# Features
+
+- Check server TPS using command
+- Check your network ping using command
+- Check other players' network ping using command
+- Works in console
+- Invalid player name detection
+- Customizeable command messages
+- Commands messages instantly updated after change
+
+# How to Install
+
+1. Download the latest version (It is recommended to always download the latest version for the best experience, except you're having compatibility issues).
+2. Put the `KygekPingTPS.jar` file into the `plugins` folder.
+3. Restart or start your server.
+4. Done!
+
+# Commands & Permissions
+
+| Command | Description | Permission | Default |
+| --- | --- | --- | --- |
+| `/ping [player]` | Current ping of a player | `kygekpingtps.ping` | true |
+| `/tps` | Current TPS of the server | `kygekpingtps.tps` | true |
+
+# Upcoming Features
+
+- Automatic plugin update checker on server startup
+
+# Additional Notes
+
+KygekPingTPS plugin is made by KygekTeam and licensed under GPL-3.0.
+
+- Join our Discord server <a href="https://discord.gg/CXtqUZv">here</a> for latest updates from KygekTeam.
+- If you found bugs or want to give suggestions, please visit <a href="https://github.com/KygekTeam/KygekPingTPS-Nukkit/issues">here</a> or join our Discord server.
+- We accept all contributions! If you want to contribute please make a pull request in <a href="https://github.com/KygekTeam/KygekPingTPS-Nukkit/pulls">here</a>.