From 5cc2a379852f50af23d999713438e795bcc003a8 Mon Sep 17 00:00:00 2001
From: Fr4nz D13trich <fr4nz@mailbox.org>
Date: Sun, 28 Dec 2025 00:19:05 +0100
Subject: [PATCH] update

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 devdoc.md |  1 +
 2 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ac7a87d..c154eeb 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,40 @@
 # Helium Bowser installer & updater
 ## Purpose
-This script was initially designed to just update my Helium browser but over time and interest it got more functional and universal. With "little" tinkering it should be possible to apply this script to install, update & configure many kinds of releases from source like AppImages, binaries, etc...
+This script was initially designed to just update my Helium browser but over time and interest it got more functional and universal. It includes functions to install, update, remove, add launcher, etc...
+
+With "little" tinkering it should be possible to apply this script to install, update & configure many kinds of releases from source, like Debian packages, AppImages, binaries, etc...
+## Usage
+Help
+```sh
+./helium_helper.sh -h
+```
+### First Install
+To initally install Helium browser via this script, download helium_helper.sh and make it executable:
+```sh
+wget https://lab.c95.org/fr4nz/helium-helper/raw/branch/main/helium_helper.sh && chmod +x helium_helper.sh
+```
+Run script with install parameter _-i_
+```sh
+./helium_helper.sh -i
+```
+Add alias to `.shellrc` | _optional_
+```sh
+./helium_helper.sh -a   ### ONLY TESTED WITH zsh & bash
+```
+---
+### Updating
+**From launcher** if added
+Checking for the latest version and updating can simply be done for the browser as well as the script by right clicking the app icon and choosing either update option, which will be run by `helium_launcher_update.sh`. This will backup all files that are being updated and write a log.
+
+**Terminal**
+Updating can also be done by running:
+```sh
+./helium_helper.sh -u   ### UPDATE APP
+```
+```sh
+./helium_helper.sh -S   ### UPDATE SCRIPT
+```
+Since this script is interactive, it doesn't keep logs.
 ## Overview
 ### Helium_Helper.sh
 - Interactive installer, updater & configuration script
diff --git a/devdoc.md b/devdoc.md
index 2b74bf0..03b693a 100644
--- a/devdoc.md
+++ b/devdoc.md
@@ -25,6 +25,7 @@
 - APP_SOURCE variable changed
 - BRANCH variable added
 - FILE_EXTENSION variable added
+- Readme updated
 
 ## Add/To Do
 - Architecture detection