From 528d725cf80d3efea35ba7fc991e2f282b80a9fc Mon Sep 17 00:00:00 2001 From: naskya Date: Mon, 1 Jul 2024 10:22:55 +0900 Subject: [PATCH] update README --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7a23e69..27b3634 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Firefish CLI tool +# CLI tool for Firefish ## Install and Update @@ -9,45 +9,45 @@ curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash # Install pre-built executable -cargo binstall --locked --git https://firefish.dev/firefish/firefish-cli.git +cargo binstall --git https://firefish.dev/firefish/fishctl.git ``` You can update the package using the same command. ```sh -cargo binstall --locked --git https://firefish.dev/firefish/firefish-cli.git +cargo binstall --git https://firefish.dev/firefish/fishctl.git ``` ### Download pre-built executable file -You can also download the pre-built executable file from the [release page](https://firefish.dev/firefish/firefish-cli/-/releases), but you need to manage/update the file on your own. +You can also download the pre-built executable file from the [release page](https://firefish.dev/firefish/fishctl/-/releases), but you need to manage/update the file on your own. ### Install from source ```sh # Build from source -cargo install --locked --git https://firefish.dev/firefish/firefish-cli.git +cargo install --locked --git https://firefish.dev/firefish/fishctl.git ``` You can update the package using the same command. ```sh -cargo install --locked --git https://firefish.dev/firefish/firefish-cli.git +cargo install --locked --git https://firefish.dev/firefish/fishctl.git ``` ### Use pre-built OCI image -Using the `registry.firefish.dev/firefish/firefish-cli` container image, `fishctl ___` commands can be executed as +Using the `registry.firefish.dev/firefish/fishctl` container image, `fishctl ___` commands can be executed as ```sh docker run -it --rm --volume "$(pwd)":/firefish --network network_name \ - registry.firefish.dev/firefish/firefish-cli \ + registry.firefish.dev/firefish/fishctl \ fishctl ___ # or podman run -it --rm --volume "$(pwd)":/firefish --network network_name \ - registry.firefish.dev/firefish/firefish-cli \ + registry.firefish.dev/firefish/fishctl \ fishctl ___ ```