Skip to content

Commit 2ce1cbb

Browse files
committed
Update readme
1 parent ba5a28f commit 2ce1cbb

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

+25-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# scoop-search
22

3-
[![](https://goreportcard.com/badge/github.com/shilangyu/scoop-search)](https://goreportcard.com/report/github.com/shilangyu/scoop-search)
43
[![](https://github.com/shilangyu/scoop-search/workflows/ci/badge.svg)](https://github.com/shilangyu/scoop-search/actions)
54

65
Fast `scoop search` drop-in replacement 🚀
@@ -49,23 +48,39 @@ Behaves just like `scoop search` and returns identical output. If any difference
4948

5049
**Non-goal**: any additional features unavailable in scoop search
5150

51+
## Building
52+
53+
This project uses Zig. Building and running works on all platforms, not only Windows.
54+
55+
Build with (output is stored in `./zig-out/bin`):
56+
57+
```sh
58+
zig build -Doptimize=ReleaseFast
59+
```
60+
61+
Run debug with:
62+
63+
```sh
64+
zig build run -- searchterm
65+
```
66+
5267
## Benchmarks
5368

54-
Done with [hyperfine](https://github.com/sharkdp/hyperfine). `scoop-search` is on average 50 times faster.
69+
Done with [hyperfine](https://github.com/sharkdp/hyperfine). `scoop-search` is on average 350 times faster.
5570

5671
```sh
5772
❯ hyperfine --warmup 1 'scoop-search google' 'scoop search google'
58-
Benchmark #1: scoop-search google
59-
Time (mean ± σ): 76.1 ms ± 1.9 ms [User: 0.8 ms, System: 5.8 ms]
60-
Range (min … max): 73.4 ms … 82.7 ms 37 runs
73+
Benchmark 1: scoop-search google
74+
Time (mean ± σ): 60.3 ms ± 3.5 ms [User: 91.2 ms, System: 394.2 ms]
75+
Range (min … max): 55.1 ms … 73.8 ms 49 runs
6176

62-
Benchmark #2: scoop search google
63-
Time (mean ± σ): 3.910 s ± 0.015 s [User: 1.4 ms, System: 7.9 ms]
64-
Range (min … max): 3.888 s … 3.928 s 10 runs
77+
Benchmark 2: scoop search google
78+
Time (mean ± σ): 21.275 s ± 2.657 s [User: 9.604 s, System: 11.789 s]
79+
Range (min … max): 19.143 s … 27.035 s 10 runs
6580

6681
Summary
67-
'scoop-search google' ran
68-
51.37 ± 1.31 times faster than 'scoop search google'
82+
scoop-search google ran
83+
352.74 ± 48.49 times faster than scoop search google
6984
```
7085

7186
_ran on AMD Ryzen 5 3600 @ 3.6GHz_

0 commit comments

Comments
 (0)