diff --git a/README.md b/README.md index f43f609..b280660 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Silencer -A mute system with only one job that is muting players. -It is designed to be as lightweight as possible, holding only a single class, and using no traditional database of any kind. Instead, it uses [Persistent Data Containers](https://docs.papermc.io/paper/dev/pdc) to store data. +Silencer is a mute plugin designed to be as lightweight as possible, holding only a single class, and using no traditional database of any kind. Instead, it uses [Persistent Data Containers](https://docs.papermc.io/paper/dev/pdc) to store data. I quickly put this together for one of my private Minecraft servers. ## Building @@ -14,5 +13,15 @@ It is designed to be as lightweight as possible, holding only a single class, an mvn package ``` -The plugin will be in the newly-made target folder. +The plugin will be in the newly-made target folder. + +### To-do list +- [ ] Temp-mute +- [ ] Bypass permission + +### Patches + +Patches can be sent either via e-mail to hex (at) iwakura (dot) rip, or a pull request can be made. + +https://hangar.papermc.io/hexlocation/Silencer