From 87506ab5caf9863b6a4f2ded67529af09765f302 Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Tue, 12 Sep 2023 16:07:14 +0200 Subject: [PATCH] chore: update readme --- crates/cargo-codspeed/README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/crates/cargo-codspeed/README.md b/crates/cargo-codspeed/README.md index e998e8e..9546540 100644 --- a/crates/cargo-codspeed/README.md +++ b/crates/cargo-codspeed/README.md @@ -11,11 +11,27 @@ A cargo subcommand for running CodSpeed on your project ## Installation +### With `cargo-binstall`(recommended) + +[`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. + +If you don't have installed yet, you can install it with: + ```bash -cargo install cargo-codspeed +cargo install cargo-binstall +``` + +You can then install `cargo-codspeed` with: + +```bash +cargo binstall cargo-codspeed ``` -Feature `vendored-openssl` can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`. +### With `cargo` + +```bash +cargo install cargo-codspeed +``` ## Usage @@ -30,3 +46,7 @@ Options: -h, --help Print help information -V, --version Print version information ``` + +## Advanced Usage + +The `vendored-openssl` feature can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`.