NotAShelf/mdlinkt
1
0
Fork 0
mirror of https://github.com/NotAShelf/mdlinkt.git synced 2024-11-25 14:46:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add benchmarks

Browse source
This commit is contained in:
raf 2023-12-30 00:16:35 +03:00
parent 814315e184
commit 2e691da84d
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -29,6 +29,16 @@ Should you want more details on the links that are scanned, you may pass the `-v
In case of invalid links, the program will exit with exit code 1, making it perfect for usage in
GitHub actions or other pipelines.
### Performance
For a file containing **10,000 invalid links**, the **Hyperfine** benchmark is as follows.
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
| :-------------------------------- | -----------: | -------: | -------: | -------: |
| `mdlinkt -verbose -file links.md` | 822.2 ± 22.6 | 787.4 | 959.8 | 1.00 |
The test has been conducted on a **Ryzen 5 3600X**, at a **95 ± 5 MB/s** bandwitdh speed.
## Hacking
A nix flake is provided. Use `direnv allow` or `nix develop` to enter the development shell.