luci-app-attendedsysupgrade: add README
authorPaul Spooren <mail@aparcar.org>
Sun, 12 Sep 2021 09:36:41 +0000 (23:36 -1000)
committerPaul Spooren <mail@aparcar.org>
Wed, 15 Sep 2021 07:27:28 +0000 (21:27 -1000)
The app should be explained.

Signed-off-by: Paul Spooren <mail@aparcar.org>
applications/luci-app-attendedsysupgrade/README.md [new file with mode: 0644]

diff --git a/applications/luci-app-attendedsysupgrade/README.md b/applications/luci-app-attendedsysupgrade/README.md
new file mode 100644 (file)
index 0000000..36f002f
--- /dev/null
@@ -0,0 +1,11 @@
+# luci-app-attendedsysupgrade
+
+This app allows firmware upgrades of routers while keeping user installed packages.
+To do so the app sends a request to an *Atttended SysUpgrade server* which will
+respond with a custom image, containing all previously installed packages.
+
+The process takes per images between 30 seconds and 5 minutes, please be
+patient.
+
+More information on the backend server and how to host one are available on the
+projects page: https://github.com/aparcar/asu/