From 424826e60dddc2e5a15aad08da1e9e7b48d2f8f5 Mon Sep 17 00:00:00 2001 From: caem Date: Thu, 16 May 2024 21:56:40 +0200 Subject: [PATCH] Update documentation --- README.md | 14 ++++++++++++++ webpautoconv.bash | 7 ++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b088489..da0f17d 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,17 @@ to be removed by zypper. #### Overview of arguments This script takes no arguments. + +### `webpautoconv.bash` +This script scans directories for webp files and converts them to png files. It can also be run as a daemon +that runs whenever a file is created in the specified (sub)directories. + +#### Overview of arguments +``` +arguments: + -c/--config [config file] (optional) {default:~/.config/webpautoconv} + -d/--directory [scan directory] (optional) {default:~/Downloads} + -w/--watch [none] (optional) {default:off} + -r/--recursive [non] (optional) {default:off} +``` + diff --git a/webpautoconv.bash b/webpautoconv.bash index eb0f9c5..54255af 100755 --- a/webpautoconv.bash +++ b/webpautoconv.bash @@ -67,7 +67,12 @@ args() { while [ -n "$1" ]; do case "$1" in "" | "-h" | "--help") - echo "unimplemented" + printf "\n\ +arguments:\n\ + -c/--config [config file] (optional) {default:~/.config/webpautoconv}\n\ + -d/--directory [scan directory] (optional) {default:~/Downloads}\n\ + -w/--watch [none] (optional) {default:off}\n\ + -r/--recursive [non] (optional) {default:off}\n" exit 0 ;; "-c" | "--config")