Update README and metadata in preparation for future 0.5.0 release

diff --git a/Cargo.lock b/Cargo.lock
index 17494f4b1efd342bf2a073d646ef827892404776..a6fc9ab81f4189b21e797150938dfa2793fa8a26 100644 (file)
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -99,7 +99,7 @@ dependencies = [
 
 [[package]]
 name = "hashgood"
-version = "0.4.0"
+version = "0.5.0"
 dependencies = [
  "hex",
  "md-5",

diff --git a/Cargo.toml b/Cargo.toml
index d40dfe1f31c7795dc6d753ee8956bb4532bb7637..b1b69818f8132832cd233cbfa827ad2bd1ada5cf 100644 (file)
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,9 +1,9 @@
 [package]
 name = "hashgood"
 description = "Interactive CLI utility for verifying file checksums"
-homepage = "https://github.com/thombles/hashgood"
-repository = "https://github.com/thombles/hashgood"
-version = "0.4.0"
+homepage = "https://octet-stream.net/p/hashgood/"
+repository = "https://code.octet-stream.net/hashgood/"
+version = "0.5.0"
 authors = ["Thomas Karpiniec <tom.karpiniec@outlook.com>"]
 edition = "2021"
 license = "Apache-2.0"

diff --git a/README.md b/README.md
index 33cbdaf23b9ca9cd3a72f67e37711775d17e07d5..a65754bc978b8c5cafa0d0d6b0e9159fbd19deec 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,59 +1,15 @@
 # hashgood
-A CLI tool for easily verifying a downloaded file's checksum.
-
-Wouldn't it be nice if your computer compared the hash for you?
-
-![](img/fail.png)
-![](img/maybe.png)
-
-Read the MD5, SHA1 or SHA256 hash from:
-
-* Command line argument
-* SHASUMS-style check files (`-c`)
-* Raw hash in a file/STDIN (`-c`)
-* The clipboard (`-p`)
-
-...or just run `hashgood` against the input and receive all three at once.
-
-This program arose from dissatisfaction with the [workarounds required for traditional tools](https://thomask.sdf.org/blog/2019/05/05/techniques-for-verifying-shasums-conveniently.html).
-
-## Installing
-
-If you have a working Rust toolchain you can install `hashgood` from crates.io:
-
-```
-cargo install hashgood --features paste
-```
-
-Pre-compiled binaries for common platforms can be downloaded [from the releases page](https://github.com/thombles/hashgood/releases). Otherwise you can build it yourself; see the next section.
 
-## Compiling
+A CLI tool for easily verifying a downloaded file's checksum.
 
-`hashgood` targets stable Rust. With a Rust toolchain installed, clone the repository and run:
+For user documentation, pre-built binaries, and more information about the project's goals, please visit the [website](https://octet-stream.net/p/hashgood/).
 
-```
-cargo build --release
-```
+## Build or Install from Source
 
-Take the compiled executable from `target/release/hashgood`.
+`hashgood` is a standard Rust binary project that can be built with `cargo build --release`.
 
-To include support for pasting from the clipboard with `-p`, specify the extra feature. Note that on Linux this requires several extra libraries: `libxcb1-dev libxcb-xfixes0-dev libxcb-shape0-dev libxcb-render0-dev`
+If you are a developer with a Rust toolchain it is possible to build and install `hashgood` directly from crates.io:
 
 ```
-cargo build --release --features paste
+cargo install hashgood
 ```
-
-## Goals
-
-* Be forgiving and deliver what the user wants with a minimum of fuss. They just want to check this hash, damnit.
-* Don't let users be tricked - be explicit about checksum types and the sources of those checksums that are being compared.
-* As much cross-platform support as is practical.
-
-## Non-goals
-
-* Scriptability. This is an interactive tool.
-* Support for any unusual scenarios that could compromise smooth operation. (e.g., text mode, uncommon hash types)
-
-## Future ideas
-
-* Nominate a default (downloads) directory and auto-select the most recently created file in that directory as input.

diff --git a/img/fail.png b/img/fail.png
deleted file mode 100644 (file)
index 9ff9df9..0000000
Binary files a/img/fail.png and /dev/null differ

diff --git a/img/maybe.png b/img/maybe.png
deleted file mode 100644 (file)
index 5fcdc64..0000000
Binary files a/img/maybe.png and /dev/null differ