From d5976b3c074b2606f3098beb735b40871761b734 Mon Sep 17 00:00:00 2001 From: Jiahao XU Date: Tue, 9 Jan 2024 00:35:07 +1100 Subject: [PATCH] Add `cargo-binstall` support for gitoxide So that `cargo-binstall` can download official pre-built binaries from the github release. Signed-off-by: Jiahao XU --- Cargo.toml | 4 ++++ README.md | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 3577694b8ac..8ba3c74902e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -308,3 +308,7 @@ faster-hex = { version = "0.9.0" } [package.metadata.docs.rs] features = ["document-features", "max"] + +[package.metadata.binstall] +pkg-url = "{ repo }/releases/download/v{ version }/gitoxide-max-pure-v{ version }-{ target }{ archive-suffix }" +bin-dir = "gitoxide-max-pure-v{ version }-{ target }/{ bin }{ binary-ext }" diff --git a/README.md b/README.md index b65f100eed9..6aaf912a8ba 100644 --- a/README.md +++ b/README.md @@ -161,10 +161,10 @@ Our [stability guide] helps to judge how much churn can be expected when dependi ### Download a Binary Release -Using `cargo quickinstall`, one is able to fetch [binary releases][releases]. You can install it via `cargo install cargo-quickinstall`, assuming +Using `cargo binstall`, one is able to fetch [binary releases][releases]. You can install it via `cargo install cargo-quickinstall`, assuming the [rust toolchain][rustup] is present. -Then install gitoxide with `cargo quickinstall gitoxide`. +Then install gitoxide with `cargo binstall gitoxide`. See the [releases section][releases] for manual installation and various alternative builds that are _slimmer_ or _smaller_, depending on your needs, for _Linux_, _MacOS_ and _Windows_.