From a5ffba1ffb2b5c995e81b5fd63409f185f6c9720 Mon Sep 17 00:00:00 2001 From: azzamsa <17734314+azzamsa@users.noreply.github.com> Date: Thu, 15 Sep 2022 18:22:28 +0700 Subject: [PATCH] docs: add unsupported crate example (#385) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 550bd524..4f057d2d 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,18 @@ Package versions and targets may be specified using the `--version` and `--targe To install an unsupported crate, you may specify the Cargo.toml metadata entries for `pkg-url`, `bin-dir`, and `pkg-fmt` at the command line, with values [as documented below](#supporting-binary-installation). For example: -``` +```shell $ binstall \ --pkg-url="{ repo }/releases/download/{ version }/{ name }-{ version }-{ target }.{ archive-format }" \ --pkg-fmt="txz" crate_name + +$ # fnm for x86_64-unknown-linux-gnu only +$ cargo binstall fnm --pkg-url="https://github.com/Schniz/fnm/releases/download/v{ version }/fnm-linux.zip" \ + --pkg-fmt zip --bin-dir "{ bin }" --install-path /opt + +$ # broot +$ cargo binstall broot --pkg-url="https://github.com/Canop/broot/releases/download/v{ version }/broot_{ version }.zip" \ + --pkg-fmt zip --bin-dir "{ target }/{ bin }" --install-path /opt ``` ## FAQ