Skip to content

Commit 87506ab

Browse files
committed
chore: update readme
1 parent c3aaa72 commit 87506ab

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

crates/cargo-codspeed/README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,27 @@ A cargo subcommand for running CodSpeed on your project
1111

1212
## Installation
1313

14+
### With `cargo-binstall`(recommended)
15+
16+
[`cargo-binstall`](https://github.com/cargo-bins/cargo-binstall) enables you to install binaries directly without having to build from the source(with `cargo install`) every time.
17+
18+
If you don't have installed yet, you can install it with:
19+
1420
```bash
15-
cargo install cargo-codspeed
21+
cargo install cargo-binstall
22+
```
23+
24+
You can then install `cargo-codspeed` with:
25+
26+
```bash
27+
cargo binstall cargo-codspeed
1628
```
1729

18-
Feature `vendored-openssl` can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`.
30+
### With `cargo`
31+
32+
```bash
33+
cargo install cargo-codspeed
34+
```
1935

2036
## Usage
2137

@@ -30,3 +46,7 @@ Options:
3046
-h, --help Print help information
3147
-V, --version Print version information
3248
```
49+
50+
## Advanced Usage
51+
52+
The `vendored-openssl` feature can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`.

0 commit comments

Comments
 (0)