From 6490070e48fbc637968eecc2698f20f5e3a3ab1c Mon Sep 17 00:00:00 2001
From: pgijsbertsen <117165507+pgijsbertsen@users.noreply.github.com>
Date: Mon, 26 Jan 2026 10:57:16 +0100
Subject: [PATCH] chore: Add Readme

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 655a5de..1733320 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
-# infrastructure
+# Hobbyrack Infrastructure
 
+This repository contains the infrastructure-as-code configuration for managing Wheatley, a homelab environment within Hobbyrack. The current focus is on deploying a Kubernetes clusters with Talos and Cilium on Proxmox VE using OpenTofu.
+
+## Contents
+
+- **modules/**: Contains reusable modules for cluster bootstrap and node provisioning.
+  - **talos-bootstrap/**: Bootstraps the Talos cluster, including templates for machine configuration and Cilium installation.
+  - **talos-node/**: Provisions individual Talos node VMs on Proxmox.
+- **pve01.wheatley.in/**: Configuration specific to the Proxmox VE host `pve01.wheatley.in`.
+  - **k8s-wheatley/**: Provisions the `k8s-wheatley` Kubernetes cluster.
+  - **templates/**: Provisions VM templates on the PVE host.
+
+## Requirements
+
+- [OpenTofu](https://opentofu.org/) >= 1.0
+- Access to a Proxmox VE environment
+- (Optional) talosctl for managing Talos nodes
+
+## Usage
+
+1. **Initialize OpenTofu**
+   ```sh
+   tofu init
+   ```
+2. **Review the execution plan**
+   ```sh
+   tofu plan
+   ```
+3. **Apply the infrastructure**
+   ```sh
+   tofu apply
+   ```
+
+> Adjust variables in `variables.tf` or provide a `terraform.tfvars` file for your environment.
+
+## Modules
+
+- **talos-bootstrap**: Bootstraps the cluster, including generating machine configurations and Cilium manifests.
+- **talos-node**: Provisions control-plane and worker nodes.
+
+## Templates
+
+- Machine configurations for Talos control-plane and worker nodes
+- Cilium installation manifest
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This repository is licensed under the MIT License. See the `LICENSE` file for details.
+
+## Contact
+
+For questions or support, open an issue or contact via GitHub.