From 7a9053973d9f4688c5165bf5fe6acfbb7c44b5a8 Mon Sep 17 00:00:00 2001
From: Alexander Medvednikov <alexander@medvednikov.com>
Date: Wed, 15 Apr 2026 15:15:08 +0300
Subject: [PATCH] compress.zstd: fix use zstd example outputting nothing (fixes
 #25071)

---
 vlib/compress/zstd/README.md                 | 21 ++++++++++++++++++++
 vlib/compress/zstd/examples/read_zstd_file.v | 13 ++++++++++++
 2 files changed, 34 insertions(+)
 create mode 100644 vlib/compress/zstd/examples/read_zstd_file.v

diff --git a/vlib/compress/zstd/README.md b/vlib/compress/zstd/README.md
index cc61c5c74..b61a4441c 100644
--- a/vlib/compress/zstd/README.md
+++ b/vlib/compress/zstd/README.md
@@ -2,3 +2,24 @@
 
 `compress.zstd` is a module that assists in the compression and
 decompression of binary data using `zstd` compression.
+
+## Examples
+
+Decode a `.zst` file from disk:
+
+```v
+import os
+import compress.zstd
+
+fn main() {
+	compressed := os.read_bytes('document.zst') or { panic(err) }
+	decompressed := zstd.decompress(compressed) or { panic(err) }
+	println(decompressed.bytestr())
+}
+```
+
+For a runnable example in this repository, see
+[examples/read_zstd_file.v](examples/read_zstd_file.v).
+
+`read_zstd_files_test.v` is a test file. Run it with
+`v test read_zstd_files_test.v`, not with `v read_zstd_files_test.v`.
diff --git a/vlib/compress/zstd/examples/read_zstd_file.v b/vlib/compress/zstd/examples/read_zstd_file.v
new file mode 100644
index 000000000..34fe11489
--- /dev/null
+++ b/vlib/compress/zstd/examples/read_zstd_file.v
@@ -0,0 +1,13 @@
+module main
+
+import os
+import compress.zstd
+
+const sample_file = os.join_path(os.dir(@FILE), '..', 'samples', 'known.zst')
+
+fn main() {
+	compressed := os.read_bytes(sample_file) or { panic(err) }
+	decompressed := zstd.decompress(compressed) or { panic(err) }
+	println('decoded `${sample_file}`:')
+	println(decompressed.bytestr())
+}
-- 
2.39.5