diff --git a/README.md b/README.md index da5ddaed..2d4a496b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # Minecraft Server Hub ### A web-interface for managing multiple Minecraft Servers based on SSH Connections + +Manage all your Minecraft Servers from one Web interface! + +## Warning +#### Compatibility is very limited currently +System Requirements: +- Linux Operating System +- Required Programs + - `screen` + - `wget` + - `tar` +- Authentication + - Currently only supports OAuth2 Authentication through [JetBrains Hub](https://www.jetbrains.com/hub/) +- Database + - Currently only supports MySQL + +### Known issues +- View and Edit server is bugged +- Edit User/Server permissions in web incomplete; please modify the DB instead +- Console page sometimes does not connect