]> code.octet-stream.net Git - hashgood/blobdiff - README.md
Update README and metadata in preparation for future 0.5.0 release
[hashgood] / README.md
index 295200de50957e300012bbad6510515b2af9ecc5..a65754bc978b8c5cafa0d0d6b0e9159fbd19deec 100644 (file)
--- 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
+```