Update README.md

README.md

@@ -1,2 +1,64 @@
-# proxmox-vm-disk-resize
+# Proxmox VM Disk Resize Script
 
+A robust bash script for safely expanding disk space on Ubuntu VMs running on Proxmox. This script automates the post-GUI disk expansion process with built-in safety checks and backup features.
+
+## Features
+
+- Automated LVM partition resizing
+- Partition table backup
+- Pre-execution requirement verification
+- Post-resize validation
+- Comprehensive error handling
+- Progress monitoring
+
+## Prerequisites
+
+- Ubuntu-based VM on Proxmox
+- Root access to the VM
+- Standard LVM setup (ubuntu-vg/ubuntu-lv)
+- Required tools: parted, pvresize, lvresize, resize2fs
+
+## Quick Start
+
+1. Expand disk in Proxmox GUI first
+2. Clone this script:
+```bash
+wget https://git.hhf.technology/hhf/proxmox-vm-disk-resize/raw/branch/main/resize_vm_disk.sh
+```
+
+3. Make script executable:
+```bash
+chmod +x resize_vm_disk.sh
+```
+
+4. Run the script as root:
+```bash
+sudo ./resize_vm_disk.sh
+```
+
+## Safety Features
+
+- Automatic partition table backup
+- System requirement verification
+- LVM setup validation
+- Filesystem integrity checks
+- Error handling with detailed messages
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Inspired by the Proxmox community
+- Built with ❤️ for system administrators
+
+## Support
+
+For detailed usage instructions, visit our [comprehensive guide](https://forum.hhf.technology/t/safely-expand-your-proxmox-vm-disk-ubuntu-24-04-a-step-by-step-guide-with-automated-script).
+
+For issues and feature requests, please use the [forum comments](https://forum.hhf.technology/t/safely-expand-your-proxmox-vm-disk-ubuntu-24-04-a-step-by-step-guide-with-automated-script/445).