actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-04-24 14:28:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: mention quickinstall telemetry collection in --help and README (#1890)

Browse source 
* docs: mention `quickinstall` telemetry collection in `--help` and README

These changes describe the usage statistics collected when the
`quickinstall` strategy is used by default, according to the discussion
and details brought forward on
https://github.com/cargo-bins/cargo-binstall/issues/1884. Both the
project README and the CLI long help contain clear disclosures of such
statistics collection now.

Signed-off-by: Alejandro González <me@alegon.dev>

* docs: add some more data collection details

Signed-off-by: Alejandro González <me@alegon.dev>

---------

Signed-off-by: Alejandro González <me@alegon.dev>
This commit is contained in:
Alejandro González 2024-08-20 12:24:13 +02:00 • committed by GitHub
parent 6cb09fd1e2
commit b599493600
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
crates/bin/src/args.rs
View file

@ -25,7 +25,13 @@ use zeroize::Zeroizing;
#[clap(
version,
about = "Install a Rust binary... from binaries!",
after_long_help = "License: GPLv3. Source available at https://github.com/cargo-bins/cargo-binstall",
after_long_help =
"License: GPLv3. Source available at https://github.com/cargo-bins/cargo-binstall\n\n\
Some crate installation strategies may collect anonymized usage statistics by default. \
If you prefer not to participate on such data collection, you can opt out by using the \
`--disable-telemetry` flag or its associated environment variable. For more details \
about this data collection, please refer to the mentioned flag or the project's README \
file",
arg_required_else_help(true),
// Avoid conflict with version_req
disable_version_flag(true),