Skip to content

Commit f5d843b

Browse files
committed
docs: add benchmarking to torrent repo README
1 parent 67ff5c4 commit f5d843b

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

packages/torrent-repository/README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
1-
# Torrust Tracker Configuration
1+
# Torrust Tracker Torrent Repository
22

3-
A library to provide torrent repository to the [Torrust Tracker](https://github.com/torrust/torrust-tracker).
3+
A library to provide a torrent repository to the [Torrust Tracker](https://github.com/torrust/torrust-tracker).
4+
5+
## Benchmarking
6+
7+
```console
8+
cargo bench -p torrust-tracker-torrent-repository
9+
```
10+
11+
Example partial output:
12+
13+
```output
14+
Running benches/repository_benchmark.rs (target/release/deps/repository_benchmark-a9b0013c8d09c3c3)
15+
add_one_torrent/RwLockStd
16+
time: [63.057 ns 63.242 ns 63.506 ns]
17+
Found 12 outliers among 100 measurements (12.00%)
18+
2 (2.00%) low severe
19+
2 (2.00%) low mild
20+
2 (2.00%) high mild
21+
6 (6.00%) high severe
22+
add_one_torrent/RwLockStdMutexStd
23+
time: [62.505 ns 63.077 ns 63.817 ns]
24+
```
425

526
## Documentation
627

0 commit comments

Comments
 (0)