README updated

2025-08-18 11:00:32 +00:00
parent 43b5aa74a5
commit c6eec03bea
1 changed files with 7 additions and 2 deletions
@@ -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