From 80a35ad7aab47db34ddef8d2acd23aef0de91c15 Mon Sep 17 00:00:00 2001 From: Leo Vasanko Date: Sun, 17 Aug 2025 23:00:32 -0600 Subject: [PATCH] README updated --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce1cf80..b1df85f 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ You can easily see which algorithm and setting is best for your use case, benchm ## Demo on a NodeJS project's static client files -!(Compression)[compression.png] -!(Decompression)[decompression.png] +![Compression](compression.png) +![Decompression](decompression.png) ## How to Run @@ -17,3 +17,8 @@ The recommended way is to use [uv](https://github.com/astral-sh/uv) to run from ```fish uvx --from git+https://git.zi.fi/LeoVasanko/compression-benchmark.git compression-benchmark /path/to/folder ``` + +## Notes + +- Contributions and forks are welcome +- There is a Jupyter Notebook bench.ipynb as an option