feat: add readme

GrowlyX · Jul 21, 2023 · 381d263 · 381d263
1 parent 9275904
commit 381d263
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md 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.