Updated README to be synced across platforms

This commit is contained in:
Jonas_Jones 2022-07-25 15:03:29 +02:00 committed by GitHub
parent 3c3e142f77
commit 3dfc6546fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,7 +1,13 @@
# McWebserver
## About the mod
### About the mod
This mod runs a simple HTTP server alongside the minecraft server in seperate threads.
The mod allows You to host websites, share files and Server Backups directly from your server without the need of a seperate server setup. Adjust the port and design your website.
The http server has up to no performance impact on the server on idle and only slightly affects it for a short amount of time (usually a couple milliseconds) when a user visits the website or requests a file.
Currently no ssl encryption is implemented yet and therefore HTTPS isn't possible, but it's coming soon(TM).
A Forge port is also on the way.
### Warning
If used wrongly this mod can be a security risk for your server and all devices connected to the network that your server is in.