update

Home.md

@@ -3,58 +3,90 @@
 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...
 
 ## Functions
-- Install Helium
+- Install Helium **-i**
     
-- Update Helium
+- Update Helium **-u**
 
-- Remove Helium
+- Backup Helium **-b**
 
-- Add and update Desktop Launcher with extra functionality
+- Update helium_helper.sh **-S**
     
-- Add alias to `.shellrc` --> _tested with bash and zsh_
+- Remove Helium **-r**
     
-- Compare local and remote version
+- Add and update Desktop Launcher with extra functionality **-l**
     
-- Show script version
+- Add alias to `.shellrc` **-a** --> _tested with bash, fish and zsh_
     
-- Update `helium_helper.sh`
+- Compare local and remote version _app_ **-c**
     
-- Help
+- Show script version **-s**
+    
+- Help **-h**
 
 See [[detailed functions|detailed_functions]] for more information.
 
 ## Usage
-get help
+### 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**
+Run script with install parameter _-i_
+- Default install directory = `$HOME/.apps/Helium`
 ```sh
 ./helium_helper.sh -i
 ```
-Add alias to `.shellrc` | _optional_
+- Custom install directory
 ```sh
-./helium_helper.sh -a   ### ONLY TESTED WITH zsh & bash
+./helium_helper.sh -i
 ```
+**NOTE:** The install path specified won't be overridden within the script yet. Working on it...
+
+**OPTIONAL** :  Add alias to `.shellrc` | _working in zsh, bash & fish_
+- Default alias = `update-helium`
+```sh
+./helium_helper.sh -a
+```
+- Custom alias
+```sh
+./helium_helper.sh -a <ALIAS>
+```
+**NOTE:** The alias specified won't be overridden within the script yet. Working on it...
+
 ---
 ### Updating
-**From launcher** (if added)
+**From launcher** (if added during install or by running `./helium_helper.sh -l`)
 
 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:
+- Update Helium Browser
 ```sh
-./helium_helper.sh -u   ### UPDATE APP
+./helium_helper.sh -u
 ```
+- Update Helium Helper
 ```sh
-./helium_helper.sh -S   ### UPDATE SCRIPT
+./helium_helper.sh -S
 ```
-Since this script is interactive, it doesn't keep logs.
+---
+### Backing up
+Backing up pulls all important files, folders & configuration and compresses an archive, which by default is stored in `$HOME/.apps/Helium/assets`
+- Backup to default path
+```sh
+./helium_helper.sh -b
+```
+- Backup to custom path
+```sh
+./helium_helper.sh -b </PATH/TO/DESTINATION>
+```
+**NOTE:** The backup path specified won't be overridden within the script yet. Working on it...
+
+**Since this script is interactive, it doesn't keep logs.**
 &nbsp;

_Sidebar.md

@@ -1,3 +1,4 @@
+**Index**
 1. [[Introduction|Home]]
 2. [[Functions in detail|detailed_functions]]
 3. [[Porting|porting]]

detailed_functions.md

@@ -1,37 +1,51 @@
 # Functions in detail
 ## No parameter
 1.  Run dependency check for every "special" command needed for the script 
+
     1\. **TRUE** | proceed  
     2\. **FALSE** | tell what's missing && exit
+
 2.  Check for Helium folder & executable  
+
     1\. **TRUE** | proceed  
     2\. **FALSE** | tell what's missing && ask to install Helium or exit
+
 3.  Update Helium  
+
     1\. See update process
+
 4.  Check for temporary directory, remove if present && exit
 
 ## Install process
 1.  Check for Helium executable  
+
     1\. **TRUE** | try to update helium  
     2\. **FALSE** | ask for install confirmation && proceed or exit
+
 2.  Get latest download URL & file name with `curl`
 3.  Download given file to `tmp` with `wget`
 4.  Make file executable `chmod`
 5.  Create app folder
 6.  Move file to app folder
 7.  Ask to add launcher
+
     1\. **TRUE** | run add launcher function && proceed  
     2\. **FALSE** | proceed
+
 8.  Check for temporary directory, remove if present && exit
 
 ## Update process
 1. Check local and remote version tags
+
     1\. **TRUE** | proceed  
     2\. **FALSE** | tell whats wrong && exit
+
 2. Compare local and remote version tags 
+
     1\. **EQUAL** | tell okay && exit
     2\. **GT** | show local and remote version && ask for confirmation && proceed or exit
     3\. **ELSE** | show local and remote version && exit
+
 3. Create `tmp` & `backup` path
 4. Download file to `tmp` with `wget`
 5. Make file executable `chmod`
@@ -44,8 +58,10 @@
 
 ## Removal process
 1. Check presence of Helium folder
+
     1\. **TRUE** | ask for removal confirmation && proceed or exit  
     2\. **FALSE** | tell && exit
+    
 2. Remove Helium folder
 3. Remove launcher if present
 4. Remove alias if present