From bf6bf28635be2c9ef4d4726ee3f48ed992abf4a2 Mon Sep 17 00:00:00 2001
From: filifa <filifa.breath652@8alias.com>
Date: Mon, 2 Sep 2024 21:03:17 -0500
Subject: [PATCH] add program description

---
 README.md   | 12 +++++++++---
 cmd/root.go |  9 +++------
 2 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index a7c0306..7012949 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
 # milkbucket
+milkbucket is an audio visualizer. It uses
+[Milkdrop](https://www.geisswerks.com/milkdrop/) preset files to generate
+visualizations from standard input.
 
 ## Build
 milkbucket depends on the
@@ -20,13 +23,16 @@ generate the PCM stream, then pipe to milkbucket, like so:
 ffmpeg -i $audio -ar 44100 -f s16le - | ./milkbucket -p $preset
 ```
 
-Note that neither of these commands will output any audio! If you want to hear the audio at the same time (and assuming your machine uses pipewire), run:
+Note that neither of these commands will output any audio! If you want to hear
+the audio at the same time (and assuming your machine uses pipewire), run:
 ```
 ffmpeg -i $audio -ar 44100 -f s16le - | tee >(pw-play --rate=44100 --format=s16 -) | ./milkbucket -p $preset
 ```
-(If you don't use pipewire try using `aplay` instead of `pw-play`, or some other command for playing PCM streams.)
+(If you don't use pipewire try using `aplay` instead of `pw-play`, or some
+other command for playing PCM streams.)
 
-You can also generate a visualization from your system sound. Assuming pipewire again, and that you have audio coming from Firefox, run:
+You can also generate a visualization from your system sound. Assuming pipewire
+again, and that you have audio coming from Firefox, run:
 ```
 pw-record --target Firefox - | ./milkbucket -p $preset
 ```
diff --git a/cmd/root.go b/cmd/root.go
index e154c77..de5350f 100644
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -91,13 +91,10 @@ func milkbucket(cmd *cobra.Command, args []string) {
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "milkbucket",
-	Short: "A brief description of your application",
-	Long: `A longer description that spans multiple lines and likely contains
-examples and usage of using your application. For example:
+	Short: "Audio visualizer",
+	Long: `milkbucket is an audio visualizer.
 
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+It uses Milkdrop preset files to generate visualizations from standard input.`,
 	Run: milkbucket,
 }