From 147301c076d0b02c4d2fdeae8c53043434625b5e Mon Sep 17 00:00:00 2001
From: hhf <hhf@noreply.localhost>
Date: Sat, 7 Dec 2024 14:55:06 +0530
Subject: [PATCH] Update README.md

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 74 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 625f9df..7a38a16 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,75 @@
-# proxmox-image-converter-script
+# Proxmox Image Converter
 
-Bash script for converting and importing various image formats to Proxmox VE
\ No newline at end of file
+A bash script for converting and importing virtual machine disk images from various hypervisors to Proxmox VE.
+
+## Features
+
+- Multi-format support: VMDK, VHD, VHDX, QED, QCOW2, RAW
+- Checksum verification for data integrity
+- Automatic format detection
+- Comprehensive error handling
+- Detailed logging
+- Storage validation
+- VM ID verification
+
+## Requirements
+
+- Proxmox VE 7.0 or higher
+- qemu-utils
+- md5sum
+- awk
+- grep
+
+## Installation
+
+Download the script and make the script executable:
+
+```bash
+wget https://git.hhf.technology/hhf/proxmox-image-converter-script/raw/branch/main/proxmox_converter.sh
+chmod +x proxmox_converter.sh
+```
+
+## Usage
+
+```bash
+./proxmox_converter.sh <input_image_path> <vm_id> <storage>
+```
+
+Parameters:
+- `input_image_path`: Path to the source image file
+- `vm_id`: Destination VM ID in Proxmox
+- `storage`: Target storage pool name
+
+Example:
+```bash
+./proxmox_converter.sh /path/to/windows.vmdk 100 local-lvm
+```
+
+## Logging
+
+Logs are stored in `/var/log/proxmox_converter.log`
+
+## Error Handling
+
+The script implements the following safety measures:
+- Pre-conversion checksum calculation
+- Post-conversion verification
+- Temporary directory usage
+- Automatic cleanup on failure
+- Storage availability verification
+- VM ID collision detection
+
+## Limitations
+
+- Requires root privileges for Proxmox operations
+- Source image must be readable by the executing user
+- Target storage must have sufficient space for temporary conversion
+
+## License
+
+MIT License
+
+
+## Support
+
+Open an issue for bug reports or feature requests on the forum.
\ No newline at end of file