From 2b643cf186f301fff4f015859c0464349ae5558f Mon Sep 17 00:00:00 2001 From: Chawye Hsu Date: Fri, 21 Jul 2023 22:50:34 +0800 Subject: [PATCH] chore: update readme Signed-off-by: Chawye Hsu --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/README.md b/README.md index 48191bb..778a289 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,55 @@ > Hok is a CLI implementation of Scoop in Rust +[![cicd][cicd-badge]][cicd] +[![release][release-badge]][releases] +[![license][license-badge]](LICENSE) + ## Install 🚧 **CAVEAT**: Under heavy development. Interfaces may change without notice, do NOT use it for production! +Assuming you have the original Scoop installed, simply run: + ```sh scoop bucket add dorado https://github.com/chawyehsu/dorado scoop install dorado/hok ``` +## Commands + +The command line interface is similar to Scoop. + +``` +$ hok help +Hok is a CLI implementation of Scoop in Rust + +Usage: hok.exe + +Commands: + bucket Manage manifest buckets + cache List or remove download caches + cat Display manifest content of a package + cleanup Cleanup apps by removing old versions + config Configuration manipulations + hold Hold package(s) to disable updates + home Open the homepage of given package + info Display information about a package + install Install package(s) + list List installed package(s) + search Search available package(s) + unhold Unhold package(s) to enable updates + update Fetch and update all buckets + upgrade Upgrade installed package(s) + help Print this message or the help of the given subcommand(s) + +Options: + -h, --help Print help + -V, --version Print version + +Type 'hok help ' to get help for a specific command. +``` + ## Development Prerequisites: Git, Rust @@ -35,3 +75,9 @@ TBD For licenses of sub crates, see [COPYING](COPYING). > [Blog](https://chawyehsu.com) · GitHub [@chawyehsu](https://github.com/chawyehsu) · Twitter [@chawyehsu](https://twitter.com/chawyehsu) + +[cicd-badge]: https://github.com/chawyehsu/hok/workflows/CICD/badge.svg +[cicd]: https://github.com/chawyehsu/hok/actions/workflows/cicd.yml +[release-badge]: https://img.shields.io/github/v/release/chawyehsu/hok +[releases]: https://github.com/chawyehsu/hok/releases/latest +[license-badge]: https://img.shields.io/github/license/chawyehsu/hok