README updated

This commit is contained in:
Leo Vasanko 2025-08-17 23:00:32 -06:00
parent dd3d0c63c4
commit 80a35ad7aa

View File

@ -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 ## Demo on a NodeJS project's static client files
!(Compression)[compression.png] ![Compression](compression.png)
!(Decompression)[decompression.png] ![Decompression](decompression.png)
## How to Run ## How to Run
@ -17,3 +17,8 @@ The recommended way is to use [uv](https://github.com/astral-sh/uv) to run from
```fish ```fish
uvx --from git+https://git.zi.fi/LeoVasanko/compression-benchmark.git compression-benchmark /path/to/folder 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