diff --git a/README.md b/README.md index dd1357b..e5708a3 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,33 @@ ## First Time Use -## Features +## Features +* **Easy to use** + - One central command that can: + - Show you the **top 10** on your server for all possible statistics + - See those same statistics for any **individual player** + - Guide you through the available options while you type with an extensive **tab-complete** feature + +[Top_10](src/main/resources/images/.png) +[Player_Stat](src/main/resources/images/.png) +[Tab_Complete](src/main/resources/images/.png) + +* **No set-up required** + - PlayerStats will work correctly regardless of how long your server has already existed - it doesn't + have to be present when you start a new world + - Data is retrieved directly from already existing playerfiles, so you don't have to + set up a database, use scoreboards, or anything of the sort + + +* **Safe** + - PlayerStats uses **multi-threading** to ensure server performance does not suffer and + players cannot crash the server by spamming its commands + +* **Customizable** + - Many options + +## Disclaimer +For big servers... ## Author Info I am a relatively new programmer, and this is one of my first projects. I greatly enjoyed making it, @@ -12,5 +38,5 @@ please let me know! You can find me on [GitHub](https://github.com/Artemis-the-g or reach me by email: artemis.the.gr8@gmail.com ## Licence -RegenAssist is licenced under the MIT licence. Please see [LICENCE](LICENSE) for more information. +PlayerStats is licenced under the MIT licence. Please see [LICENCE](LICENSE) for more information.