From 381d263597d470d78e248b9de71d81c71c4db8c5 Mon Sep 17 00:00:00 2001
From: Subham <growlyxdev@gmail.com>
Date: Fri, 21 Jul 2023 01:46:56 -0400
Subject: [PATCH] feat: add readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

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.