docs: Add Readme (#2)

readme.md

@@ -0,0 +1,82 @@
+<h1 align="center">Proxmox<br />
+<div align="center">
+<a href="https://github.com/dockur/proxmox/"><img src="https://github.com/dockur/proxmox/raw/master/.github/logo.png" title="Logo" style="max-width:100%;" width="128" /></a>
+</div>
+<div align="center">
+
+[![Build]][build_url]
+[![Version]][tag_url]
+[![Size]][tag_url]
+[![Pulls]][hub_url]
+
+</div></h1>
+
+Proxmox inside a Docker container.
+
+## Features ✨
+
+ - KVM acceleration
+ - Web-based viewer
+ - Automatic download
+
+## Usage  🐳
+
+##### Via Docker Compose:
+
+```yaml
+services:
+  proxmox:
+    image: dockurr/proxmox
+    container_name: proxmox
+    devices:
+      - /dev/kvm
+      - /dev/net/tun
+    cap_add:
+      - NET_ADMIN
+    ports:
+      - 8006:8006
+    volumes:
+      - ./proxmox:/storage
+    restart: always
+    stop_grace_period: 2m
+```
+
+##### Via Docker CLI:
+
+```bash
+docker run -it --rm --name proxmox -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/proxmox:/storage" --stop-timeout 120 docker.io/dockurr/proxmox
+```
+
+##### Via Kubernetes:
+
+```shell
+kubectl apply -f https://raw.githubusercontent.com/dockur/proxmox/refs/heads/master/kubernetes.yml
+```
+
+##### Via Github Codespaces:
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/dockur/proxmox)
+
+## FAQ 💬
+
+### How do I use it?
+
+  Very simple! These are the steps:
+
+## Acknowledgements 🙏
+
+Special thanks to [rtedpro-cpu](https://github.com/rtedpro-cpu), this project would not exist without his invaluable work.
+
+## Stars 🌟
+[![Stars](https://starchart.cc/dockur/proxmox.svg?variant=adaptive)](https://starchart.cc/dockur/proxmox)
+
+[build_url]: https://github.com/dockur/proxmox/
+[hub_url]: https://hub.docker.com/r/dockurr/proxmox/
+[tag_url]: https://hub.docker.com/r/dockurr/proxmox/tags
+[pkg_url]: https://github.com/dockur/proxmox/pkgs/container/proxmox
+
+[Build]: https://github.com/dockur/proxmox/actions/workflows/build.yml/badge.svg
+[Size]: https://img.shields.io/docker/image-size/dockurr/proxmox/latest?color=066da5&label=size
+[Pulls]: https://img.shields.io/docker/pulls/dockurr/proxmox.svg?style=flat&label=pulls&logo=docker
+[Version]: https://img.shields.io/docker/v/dockurr/proxmox/latest?arch=amd64&sort=semver&color=066da5
+[Package]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fdockur%2Fproxmox%2Fproxmox.json&query=%24.downloads&logo=github&style=flat&color=066da5&label=pulls