chore: add readme

This commit is contained in:
ColdDev 2022-10-23 21:51:39 +01:00
parent 00ce8caa94
commit f6cb449af3

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# Uranium
Uranium is a moderation utility built for Eaglercraft 1.8 servers. **THIS PLUGIN WILL NOT WORK ON CRAFTBUKKIT 1.5.2, SO DO NOT TRY IT!**
## How to Install
- Download the latest jarfile from the Releases page
- Drag and drop into your **1.8.8 server**'s plugin folder
- Restart, **not reload**, your server
- Modify the configuration file located in `plugins/Uranium/config.yml` to your liking
- ????
- Profit