From b4a4bb3ddd9b834bcdceb4889a0911965ad1c641 Mon Sep 17 00:00:00 2001
From: MacRimi <123239993+MacRimi@users.noreply.github.com>
Date: Thu, 23 Jul 2026 23:53:05 +0200
Subject: [PATCH] Delete README.md
---
README.md | 208 ------------------------------------------------------
1 file changed, 208 deletions(-)
delete mode 100644 README.md
diff --git a/README.md b/README.md
deleted file mode 100644
index ac7dc68e..00000000
--- a/README.md
+++ /dev/null
@@ -1,208 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- ProxMenux is a management tool for Proxmox VE that simplifies system administration through an interactive menu, allowing you to execute commands and scripts with ease.
-
-
----
-
-## ๐ Installation
-
-To install ProxMenux, simply run the following command in your Proxmox server terminal:
-
-```bash
-bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/main/install_proxmenux.sh)"
-```
-
-> โ ๏ธ Be careful when copying scripts from the internet. Always remember to check the source!
->
-> ๐ You can [review the source code](https://github.com/MacRimi/ProxMenux/blob/main/install_proxmenux.sh) before execution.
->
-> ๐ก๏ธ All executable links follow our [Code of Conduct](https://github.com/MacRimi/ProxMenux?tab=coc-ov-file#-2-security--code-responsibility).
-
----
-
-## ๐ How to Use
-
-Once installed, launch **ProxMenux** by running:
-
-```bash
-menu
-```
-
-Then, follow the on-screen options to manage your Proxmox server efficiently.
-
----
-
-## ๐ฅ๏ธ ProxMenux Monitor
-
-ProxMenux Monitor is an integrated web dashboard that provides real-time visibility into your Proxmox infrastructure โ accessible from any browser on your network, without needing a terminal.
-
-**What it offers:**
-
-- Real-time monitoring of CPU, RAM, disk usage and network traffic
-- Overview of running VMs and LXC containers with status indicators
-- Login authentication to protect access
-- Two-Factor Authentication (2FA) with TOTP support
-- Reverse proxy support (Nginx / Traefik)
-- Designed to work across desktop and mobile devices
-
-**Access:**
-
-Once installed, the dashboard is available at:
-
-```
-http://:8008
-```
-
-The Monitor is installed automatically as part of the standard ProxMenux installation and runs as a systemd service (`proxmenux-monitor.service`) that starts automatically on boot.
-
-**Useful commands:**
-
-```bash
-# Check service status
-systemctl status proxmenux-monitor
-
-# View logs
-journalctl -u proxmenux-monitor -n 50
-
-# Restart the service
-systemctl restart proxmenux-monitor
-```
-
----
-
-## ๐งช Beta Program
-
-Want to try the latest features before the official release and help shape the final version?
-
-The **ProxMenux Beta Program** gives early access to new functionality โ including the newest builds of ProxMenux Monitor โ directly from the `develop` branch. Beta builds may contain bugs or incomplete features. Your feedback is what helps fix them before the stable release.
-
-**Install the beta version:**
-
-```bash
-bash -c "$(wget -qLO - https://raw.githubusercontent.com/MacRimi/ProxMenux/develop/install_proxmenux_beta.sh)"
-```
-
-**What to expect:**
-
-- You'll get new features and Monitor builds before anyone else
-- Some things may not work perfectly โ that's expected and normal
-- When a stable release is published, ProxMenux will notify you on the next `menu` launch and offer to switch automatically
-
-**How to report issues:**
-
-Open a [GitHub Issue](https://github.com/MacRimi/ProxMenux/issues) and include:
-- What you did and what you expected to happen
-- Any error messages shown on screen
-- Logs from the Monitor if relevant:
-
-```bash
-journalctl -u proxmenux-monitor -n 50
-```
-
-> ๐ Thank you for being part of the beta program. Your help makes ProxMenux better for everyone.
-
----
-
-## ๐ง Dependencies
-
-The following Debian packages are installed automatically during setup:
-
-| Package | Purpose |
-|---|---|
-| `dialog` | Interactive terminal menus |
-| `curl` | Downloads and connectivity checks |
-| `jq` | JSON processing |
-| `git` | Repository cloning and updates |
-| `python3` + `python3-pip` | ProxMenux Monitor (Flask web dashboard) |
-
-UI translations ship as pre-built JSON files per language (English, Spanish, French, German, Italian, Portuguese). There is no runtime translation dependency.
-
----
-
-## ๐ค Contributing
-
-ProxMenux is an open, collaborative project โ contributions of every shape are very welcome, no matter your background. Every PR, bug report, idea, translation or kind word helps move the project forward.
-
-> ๐ **Before sending code**, please read the [**Contributing Guide**](CONTRIBUTING.md). It covers the project structure, the UI design policy (the two-phase `dialog` / `whiptail` flow), message helpers, translation policy and submission conventions โ what reviewers will look for in your PR.
-
-**Ways to help:**
-
-- ๐ป **Code** โ fix a bug, polish a script, add a feature. Read the [Contributing Guide](CONTRIBUTING.md) first, then [open a pull request](https://github.com/MacRimi/ProxMenux/pulls).
-- ๐ **Bug reports** โ found something broken? [Open an issue](https://github.com/MacRimi/ProxMenux/issues/new) with steps to reproduce, and the Monitor logs if relevant (`journalctl -u proxmenux-monitor -n 50`).
-- ๐ก **Ideas & feedback** โ share suggestions in [GitHub Discussions](https://github.com/MacRimi/ProxMenux/discussions). Every idea is welcome.
-- ๐ **Translations** โ the documentation site already supports English and Spanish; help expand it to more languages following the [translation guide](web/CONTRIBUTING-TRANSLATIONS.md) (one page per PR).
-- ๐งช **Beta testing** โ run the [beta build](#-beta-program) and let us know what you find.
-- โญ **Spread the word** โ a GitHub star or a mention in your homelab community helps others discover the project.
-
-Before contributing, please take a moment to read our [Code of Conduct](https://github.com/MacRimi/ProxMenux?tab=coc-ov-file).
-
-### Contributors
-
-Thanks to everyone who has helped make ProxMenux what it is today.
-
-
- 
-
-
-Made with [contrib.rocks](https://contrib.rocks).
-
----
-
-## โญ Support the Project
-
-If **ProxMenux** is useful to you, the simplest way to support it is a โญ on GitHub โ it really helps others discover the project.
-
-If you want to go a step further, a coffee on Ko-fi keeps development going:
-
-
-
- 
-
-
-
----
-
-## ๐ Project Growth
-
-
-
- 
-
-
-
-
- Stars and forks tracked with Repo Growth.
-
- 
- 
- 
- 
-
- 
- 
- 
-