initial commit

README.md

@@ -1,2 +1,30 @@
-# bash-helper
+## bash-helper-script
+
+A collection of helper functions to be used within your bash script.
+
+### Download via git clone
+```
+git clone https://git.x-files.dk/bash/bash-helper.git
+```
+> **NOTE**
+> The helper script should reside in the same directory as your main bash script.
+
+### How to source the script within your main bash script.
+```bash
+#!/usr/bin/env bash
+
+source "$(dirname "$0")/helper"
+
+# main bash script goes below this line
+```
+
+### Guide and howto's examples can be found here.
+Bash helper function howto [\[link\]](https://wiki.x-files.dk/doku.php?id=linux:bash_helper_howto)
+
+### More guides
+More guides can be found on [\[wiki.x-files.dk\]](https://wiki.x-files.dk)
+
+### Last tested
+August 20th 2025 on Ubuntu 24.04.
+