From 9e44df49733b2da83789e65c1ed8bbc045df4bd7 Mon Sep 17 00:00:00 2001 From: Yezzi Hsueh Date: Mon, 13 Nov 2023 14:16:36 +0800 Subject: [PATCH] docs: add usage description --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 69b732c..53ae0b3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # docker-tags -list all tags for a Docker image on a remote registry. \ No newline at end of file +List all tags for a Docker image on a remote registry. + +## Usage + +Build and install binaries into `/${CARGO_HOME}/bin` by default. + +``` +cargo install --path . --locked +``` + +> Cargo install ignores Cargo.lock by default. +> Use `--locked` to match `cargo build --release` would build. + +Change the location by `--root` option. + +``` +cargo install --path --locked --root /usr/local +``` \ No newline at end of file