From f696ce3c20753ed10eb1352f496b58c5d486c34c Mon Sep 17 00:00:00 2001
From: cyril constantin <constcyr@gmail.com>
Date: Tue, 2 Jun 2026 09:05:06 +0200
Subject: [PATCH] Add documentation

---
 README.md  | 36 +++++++++++++++++++++++++++++++++++-
 upgrade.sh |  4 ++--
 2 files changed, 37 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index cc1c83b..8c48e0d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
 # upgrade_debian_iso
 
-Upgrade debian iso with jigdo.
\ No newline at end of file
+Upgrade a provided debian iso with jigdo to last minor release.
+
+## Requirements
+
+A (recent) debian host.
+Install the packages jigdo-file wget and udisks2 on it.
+Execute the script on a physical console (not ssh) to avoid polkit issues.
+
+## Usage
+
+Adapt the config file **release-name**-**architecture**.txt to your case.
+
+```bash
+http_proxy=http://192.168.0.253:3142/
+ISOFILE=$HOME/debian-12.12.0-i386-netinst.iso
+JIGDO=$HOME/jigdo
+DESTINATION=$HOME
+MIRROR=http://debian.proxad.net
+MIRRORNONUS=http://debian.proxad.net
+```
+
+Set or remove http_proxy if you have one (like apt-cacher-ng).
+
+Set the (old) isofile path of the same release and architecture you have.
+
+Set the paths you want and a specific mirror if you want.
+
+```bash
+$ bash upgrade.sh --configfile bookworm_i386.txt
+...
+```
+
+It will upgrade the packages of the old medium file and generate a isofile in the last revision, the same as provided with a direct download.
+
+You can burn it, copy it or use it the same as a downloaded netinst file.
diff --git a/upgrade.sh b/upgrade.sh
index 9c90f40..2e87e13 100644
--- a/upgrade.sh
+++ b/upgrade.sh
@@ -7,7 +7,7 @@ check_tools()
 {
     if ! udisksctl status >/dev/null
     then 
-        echo "udisksctl is required"
+        echo "udisks2 is required"
         exit 1
     fi
     if ! wget --version >/dev/null
@@ -17,7 +17,7 @@ check_tools()
     fi
     if ! jigdo-lite --version >/dev/null
     then
-        echo "jigdo-lite is required"
+        echo "jigdo-file is required"
         exit 1
     fi
 }