From cbaa79b284049880253e6da799ae4e9ba6de5f04 Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Tue, 23 Sep 2025 14:18:50 -0400 Subject: [PATCH] Minor tweaks --- .github/workflows/build_and_test.yml | 2 +- README.MD | 38 ++++++++++++++-------------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml index 7c65946..e26f5e2 100644 --- a/.github/workflows/build_and_test.yml +++ b/.github/workflows/build_and_test.yml @@ -25,7 +25,7 @@ jobs: run: dotnet test - name: Run publish script - run: ./publish-nix.sh + run: ./publish-nix.sh -d - name: Upload to rolling uses: ncipollo/release-action@v1.14.0 diff --git a/README.MD b/README.MD index 9079695..e8a9099 100644 --- a/README.MD +++ b/README.MD @@ -12,6 +12,25 @@ For the most recent stable build, download the latest release here: [Releases Pa For the latest WIP build here: [Rolling Release](https://github.com/SabreTools/SabreTools.Hashing/releases/rolling) +## Hasher + +**Hasher** is a reference implementation for hashing and checksumming features of the library, packaged as a standalone executable for all supported platforms. It will attempt to select the correct hashing types based on input and then print the calculated values to standard output. + +``` +Hasher file|directory ... + +Options: +-?, -h, --help Display this help text and quit +-d, --debug Enable debug mode +-l, --list List all available hashes and quit +-t, --type [TYPE] Output file hashes + +If no hash types are provided, this tool will default +to outputting CRC-32, MD5, SHA-1, and SHA-256. +Optionally, all supported hashes can be output +by specifying a value of 'all'. +``` + ## Internal Implementations All hash and checksum types here have been written to ensure compatibility across all .NET versions. Some may have been adapted to ensure this compatibility. These can be treated as reference implementations, not always optimized. @@ -39,22 +58,3 @@ External implementations of hash and checksum types may not be compatible with a | [System.Security.Cryptography](https://learn.microsoft.com/en-us/dotnet/api/system.security.cryptography) | MD5, SHA-1, SHA-256, SHA-384, SHA-512, SHA3-256, SHA3-384, SHA3-512, SHAKE128, SHAKE256 | Built-in library; SHA3-256, SHA3-384, SHA3-512, SHAKE128, and SHAKE256 are `net8.0` and above only for [supported platforms](https://learn.microsoft.com/en-us/dotnet/standard/security/cross-platform-cryptography) | **Note:** If all you care about is performance, I encourage you to forego this library and use the ones listed above directly instead. - -## Hasher - -**Hasher** is a reference implementation for hashing and checksumming features of the library, packaged as a standalone executable for all supported platforms. It will attempt to select the correct hashing types based on input and then print the calculated values to standard output. - -``` -Hasher file|directory ... - -Options: --?, -h, --help Display this help text and quit --d, --debug Enable debug mode --l, --list List all available hashes and quit --t, --type [TYPE] Output file hashes - -If no hash types are provided, this tool will default -to outputting CRC-32, MD5, SHA-1, and SHA-256. -Optionally, all supported hashes can be output -by specifying a value of 'all'. -```