diff --git a/README_template_script.md b/README_template_script.md new file mode 100644 index 0000000..0f0311e --- /dev/null +++ b/README_template_script.md @@ -0,0 +1,83 @@ +# + +Kurzbeschreibung des Skripts: + + +--- + +## Features + +- Punkt 1 +- Punkt 2 +- Punkt 3 + +--- + +## Installation + +1. Repository klonen oder Skript kopieren: + ```bash + git clone /esn-support-bash-snippets.git + cd esn-support-bash-snippets// + chmod +x + ``` + +2. Abhängigkeiten (falls vorhanden) installieren: + - `jq` (optional) + - weitere Tools + +--- + +## Nutzung + +### Standardaufruf +```bash +./ +``` + +### Beispiele +```bash +./ --option foo +./ 2025-09-08 +``` + +--- + +## Optionen + +``` +Usage: ./ [OPTIONS] + +--help Zeigt diese Hilfe +--option Beispieloption +YYYY-MM-DD Beispiel für Datumsargument +``` + +--- + +## Beispielausgabe + +``` +Hier ein Beispieloutput des Skripts. +``` + +--- + +## Setup-Hinweise + +Falls notwendig, Alias in `~/.bashrc` setzen: +```bash +alias ='~/pfad/zum/repo///' +``` + +Logger-spezifisch ggf. in `~/.profile` ergänzen: +```bash +cd /var/log/easyname/$(date +%Y)/$(date +%m)/ +``` + +--- + +## Notes + +- Weitere Hinweise, Einschränkungen, Besonderheiten +- Ggf. bekannte Bugs oder ToDos