From ee8e045e1598d154bcc981138234ee2c7c86764c Mon Sep 17 00:00:00 2001
From: WeebDataHoarder <57538841+WeebDataHoarder@users.noreply.github.com>
Date: Sun, 29 Jan 2023 14:00:18 +0100
Subject: [PATCH] Added cmd/decode information on README

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index af20013..3ebe56b 100644
--- a/README.md
+++ b/README.md
@@ -197,6 +197,25 @@ This tag enables the [libalac](https://git.gammaspectra.live/S.O.N.G/go-alac) su
 
 This library has vast security issues, enable on your own risk. An alternate codec for decoding might be added in the future.
 
+## Utilities
+
+### `cmd/decode`
+Example application that decodes files and provides some general information about the decoded streams, and produces an MD5 hash of the sample data.
+Run via `$ go run git.gammaspectra.live/S.O.N.G/Kirika/cmd/decode -input "resources/samples/cYsmix - Haunted House/11. The Great Rigid Desert.flac"`
+
+Example output:
+```
+2023/01/29 12:58:27 File: resources/samples/cYsmix - Haunted House/11. The Great Rigid Desert.flac
+2023/01/29 12:58:27 Available decoders:
+2023/01/29 12:58:27     flac: reference libFLAC 1.3.3 20190804 (S.O.N.G/goflac) (analyzer)
+2023/01/29 12:58:27 Decoding as int32 24-bit @ 44100Hz 2 channel(s)
+2023/01/29 12:58:27 Decoded 17323031 sample(s)
+2023/01/29 12:58:27 Processed 4230 blocks(s) (avg 4095.28 sample(s) per block)
+2023/01/29 12:58:27 Duration 6m32.812494331s
+2023/01/29 12:58:27 MD5 hash: c1a62472ca433e6c4b02e842a8348660
+2023/01/29 12:58:27     Check via $ ffmpeg -hide_banner -loglevel error -i "resources/samples/cYsmix - Haunted House/11. The Great Rigid Desert.flac" -vn -c:a pcm_s24le -f md5 -
+2023/01/29 12:58:27 Took 385.02864ms
+```
 
 ## Licenses