diff --git a/README.md b/README.md new file mode 100644 index 0000000..b720386 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# bearformation +An opinionated Minecraft server infrastructure installation script for Ubuntu systems. + +## Provides +- **User:** + - starship.rs + - bashtop + - SSH configuration +- **System:** + - Firewall configuration + - *(Optional)* Docker configuration (with firewall integration) +- **Resources:** + - MongoDB server + - Redis server + - HashiCorp Consul (dev) (requires Docker) + +## Tested On +Bearformation has been used on Ubuntu 20.04 systems several times in the past. I cannot guarantee compatibility with any other OS configuration.