Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Chawye Hsu <su+git@chawyehsu.com>
  • Loading branch information
chawyehsu committed Jul 21, 2023
1 parent f53d477 commit 2b643cf
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <COMMAND>
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 <command>' to get help for a specific command.
```

## Development

Prerequisites: Git, Rust
Expand All @@ -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

0 comments on commit 2b643cf

Please sign in to comment.