Readme update for version 1.0 (#225)

* Readme update for next version

* update readme

* link fix

* language

* more changes

* typo

* more cleanup

---------

Co-authored-by: Meliox <na>

readme.md

@@ -3,11 +3,80 @@ A small collection of scripts and mods for Proxmox Virtual Environment (PVE)
 
 If you find this helpful, a small donation is appreciated, [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=K8XPMSEBERH3W).
 
-## Node sensor readings view
+| Version | Description | Status |
+|---------|-------------|--------|
+| **v2** (current) | Debian package (`pve-mod`) with interactive `pve-mod-configure` wizard | Recommended |
+| v1 (legacy) | Standalone bash scripts, manual install | Archived — see [Legacy section](#legacy-v1-shell-scripts) |
+
+---
+
+## Version 2 (beta) — Debian package
+
+Compatibility: PVE 9.0+
+
+TBD PICTURE
+
+`pve-mod` is a Debian package that installs UI patches and an interactive configuration wizard.
+
+### Mods
+
+| Mod | Description | Dependencies |
+|--------|-------------|--------------|
+| [`node_info`](src/modules/node_info/readme.md) | Displays sensor readings in the node summary panel: CPU, NVMe/HDD/SSD temperatures (°C/°F), fan speeds, RAM temperatures, GPU stats (Intel/NVIDIA), UPS status, and system/motherboard info. <br> Can optionally run as background sensor daemon |  - General sensors: `lm-sensors`<br>- HDD/SSD: Kernal module `drivetemp`<br>- UPS: `upsc`<br>- GPU: INTEL `intel-gpu-tools` and/or NVIDIA `nvidia-driver-* `
+| [`nag_screen`](src/modules/nag_screen/readme.md) | Removes the subscription nag screen from the PVE web UI. | - |
+
+### How it works
+
+1. The `pve-mod` package installs the mods installation, patch files under `/usr/lib/pve-mod/`.
+2. The mods main configuration file and mods can be found under `/etc/pve-mod/`.
+2. Running `pve-mod-configure` prompts for which modules to enable and configuration of mods.
+3. The wizard applies the selected patches to the PVE system files and restarts `pveproxy`.
+
+### Install
+
+Commands and mod configuration must be run as `root`.
+
+```bash
+curl -sL https://github.com/Meliox/PVE-mods/releases/latest/download/install.sh | bash
+```
+
+Install respective mod dependencies - see Mod table.
+
+Run `pve-mod-configure` to install/uninstall and configure mods.
+
+#### Manual configuration changes
+Configuration files are located in `/etc/pve-mod/`. After any manual edits, restart `pveproxy` to apply the changes:
+
+```bash
+systemctl restart pveproxy
+```
+
+### Uninstall
+
+Commands and mod configuration must be run as `root`.
+
+```bash
+apt-get remove pve-mod 
+```
+And remove dependencies needed by respective mods.
+
+### Notes
+
+Multiple node support requires application to be installed on all nodes with identical configuration. (untested)
+
+---
+
+## Legacy / v1 (shell scripts)
+
+> **These scripts are archived.** For new installations, use the [v2 Debian package](#version-2--debian-package) above.
+
+### Node sensor readings view
+
+![Proxmox temp mod](https://github.com/Meliox/PVE-mods/blob/main/pve-mod-sensors.png?raw=true)
+
 Compatibility:
 - 9.0-9.2. Newer versions may often work
 - Older version (7.x-8.x), use git version from Apr 6th 2025
-![Promxox temp mod](https://github.com/Meliox/PVE-mods/blob/main/pve-mod-sensors.png?raw=true)
 
 This bash script installs a modification to the Proxmox Virtual Environment (PVE) web user interface (UI) to display sensor readings in a flexible and readable manner.
 The following readings are possible:
@@ -15,7 +84,7 @@ The following readings are possible:
 - UPS information via Network Monitoring Tool
 - Motherboard information or system information via dmidecode
 
-### How it works
+#### How it works
 The modification involves the following steps:
 1. Backup original files in the home directory/backup
    - `/usr/share/pve-manager/js/pvemanagerlib.js`
@@ -38,7 +107,7 @@ Notes:
 - UPS support in multi-node setups require identical login credentials across nodes. This has not been fully tested.  
 - Proxmox upgrades may overwrite modified files; reinstallation of this mod could be required.  
 
-### Install
+#### Install
 Instructions be performed as 'root', as normal users do not have access to the files.
 
 ```
@@ -51,7 +120,7 @@ bash pve-mod-gui-sensors.sh install
 ```
 Additionally, adjustments are available in the first part of the script, where paths can be edited, cpucore offset and display information.
 
-## Nag screen deactivation
+### Nag screen deactivation
 (Tested compatibility: 7.x - 8.3.5)
 This bash script installs a modification to the Proxmox Virtual Environment (PVE) web user interface (UI) which deactivates the subscription nag screen.
 
@@ -65,21 +134,21 @@ The script provides three options:
 | `install`              | Installs the modification by applying the necessary changes.                |
 | `uninstall`            | Removes the modification by restoring the original files from backups.      |
 
-### Install
+#### Install
 Instructions be performed as 'root', as normal users do not have access to the files.
 ```
 wget https://raw.githubusercontent.com/Meliox/PVE-mods/refs/heads/main/legacy-scripts/pve-mod-nag-screen.sh
 bash pve-mod-nag-screen.sh install
 ```
 
-## Script to update all containers
+### Script to update all containers
 (Tested compatibility: 7.x - 8.3.5)
 
 This script updates all running Proxmox containers, skipping specified excluded containers, and generates a separate log file for each container.
 The script first updates the Proxmox host system, then iterates through each container, updates the container, and reboots it if necessary.
 Each container's log file is stored in $log_path and the main script log file is named container-upgrade-main.log.
 
-### Install
+#### Install
 ```
 wget https://raw.githubusercontent.com/Meliox/PVE-mods/refs/heads/main/legacy-scripts/updateallcontainers.sh
 ```