From b8859acc28bbf063ed58fb60d605f1f3939638f6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?O=CC=81scar=20M=2E=20Lage?= <info@oscarmlage.com>
Date: Fri, 25 Oct 2024 09:36:05 +0200
Subject: [PATCH] Added --help parameter + README

---
 README.md | 28 ++++++++++++++++++++++++++++
 main.go   | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c1ee1fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Medialog
+
+```
+Usage: go run main.go [--media ediatype] [--update]
+
+Description:
+    This command allows you to manage multimedia files and update their data in the system.
+
+Options:
+    --media <mediatype>    Specifies the type of media to process.
+                           Possible values are:
+                             - movies:    Processes movie files.
+                             - series:    Processes series files.
+                             - books:     Processes book files.
+                             - games:     Processes game files.
+                             - music:     Processes music files.
+                           If not specified, all media types will be processed.
+
+    --update               Runs in update mode to refresh existing media entries.
+                           This option is optional and requires no value.
+
+    -h, --help             Displays this help message and exits.
+
+Usage examples:
+    go run main.go --media movies           Processes only movie files.
+    go run main.go --update                 Updates all multimedia files.
+    go run main.go --media series --update  Processes and updates series files.
+```
diff --git a/main.go b/main.go
index 795a634..401dade 100644
--- a/main.go
+++ b/main.go
@@ -9,6 +9,7 @@ import (
 	"hugo-medialog/internal/music"
 	"hugo-medialog/internal/series"
 	"hugo-medialog/utils"
+	"os"
 )
 
 func main() {
@@ -18,8 +19,18 @@ func main() {
 	// --media parameter
 	media := flag.String("media", "", "Specify the media type to process: movies, series, books, games, or music")
 	update := flag.Bool("update", false, "Run in update mode to update existing entries")
+
+	// Define custom help option
+	help := flag.Bool("help", false, "Display this help message")
+	flag.BoolVar(help, "h", false, "Display this help message") // support -h as well
 	flag.Parse()
 
+	// Show help message if -h or --help is specified
+	if *help {
+		printHelp()
+		os.Exit(0)
+	}
+
 	if *media == "" {
 		processAll(*update)
 	} else {
@@ -36,6 +47,8 @@ func main() {
 			processMusic(*update)
 		default:
 			fmt.Printf("Invalid media type: %s. Please use movies, series, books, games, or music.\n", *media)
+			printHelp()
+			os.Exit(1)
 		}
 	}
 }
@@ -107,3 +120,30 @@ func processMusic(update bool) {
 		fmt.Printf("Error processing music: %v\n", err)
 	}
 }
+
+func printHelp() {
+	fmt.Println(`Usage: go run main.go [--media mediatype] [--update]
+
+Description:
+    This command allows you to manage multimedia files and update their data in the system.
+
+Options:
+    --media <mediatype>    Specifies the type of media to process. 
+                           Possible values are:
+                             - movies:    Processes movie files.
+                             - series:    Processes series files.
+                             - books:     Processes book files.
+                             - games:     Processes game files.
+                             - music:     Processes music files.
+                           If not specified, all media types will be processed.
+
+    --update               Runs in update mode to refresh existing media entries.
+                           This option is optional and requires no value.
+    
+    -h, --help             Displays this help message and exits.
+
+Usage examples:
+    go run main.go --media movies           Processes only movie files.
+    go run main.go --update                 Updates all multimedia files.
+    go run main.go --media series --update  Processes and updates series files.`)
+}