Add Home

Home.md

@@ -0,0 +1,75 @@
+# Helium Helper Script
+
+## Purpose
+
+This script was initially designed to just update my Helium browser but over time 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
+    
+- Update Helium
+    
+- Remove Helium
+    
+- Add and update Desktop Launcher
+    
+- Add alias to `.shellrc`
+    
+- Compare local and remote version
+    
+- Show script version
+    
+- Update `helium_helper.sh`
+    
+- Help
+    
+
+## Functions in detail
+
+### No parameter
+
+1.  Run dependency check for every "special" command needed for the script  
+    1\. **SUCSESS** | proceed  
+    2\. **FAIL** | tell what's missing && exit
+2.  Check for Helium folder & executable  
+    1\. **SUCSESS** | proceed  
+    2\. **FAIL** | 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`
+6. Check for old backup and remove if existent
+7. Move outdated file to `backup`
+8. Move latest file to Helium folder
+9. Create `backup` of launcher
+10. Update Launcher (version number) `sed`
+11. Check for temporary directory, remove if present && exit
+