docs: add README.md

README.md

@@ -0,0 +1,28 @@
+# Automated kubernetes cluster deployment on Proxmox VE
+
+## Quick start
+
+Create a file `.env`, which contains environment variables.
+
+Example of a `.env` file:
+```
+# Proxmox VE host
+PROXMOX_HOST='pve.office.basealt.ru'
+# Proxmox VE user
+PROXMOX_USER='stepchenkoas'
+# Proxmox VE full username (e.g. username@BaseALT)
+PROXMOX_USER_FULL="${PROXMOX_USER}@BaseALT"
+# Proxmox VE user password
+PROXMOX_PASSWORD=super-secret-password
+# Whether VMs should be deleted at the start
+DELETE_VMS=1
+```
+
+Then run the `run.sh` script.
+
+```bash
+./run.sh
+```
+
+TODO:
+- [ ] Add automatic deletion of created VMs after the tests are completed