X-Git-Url: https://code.octet-stream.net/hashgood/blobdiff_plain/1dec1ec82f55d639d9fad0d0933545aa509c4272..fe58ffda1c19d5c4d5b7ff3b42e0de7a6b7136ff:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 295200d..a65754b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # hashgood -CLI tool for easily verifying a downloaded file's checksum + +A CLI tool for easily verifying a downloaded file's checksum. + +For user documentation, pre-built binaries, and more information about the project's goals, please visit the [website](https://octet-stream.net/p/hashgood/). + +## Build or Install from Source + +`hashgood` is a standard Rust binary project that can be built with `cargo build --release`. + +If you are a developer with a Rust toolchain it is possible to build and install `hashgood` directly from crates.io: + +``` +cargo install hashgood +```