From f943df72d2854d26fff7eea21584cbae804b1a89 Mon Sep 17 00:00:00 2001 From: Your Name Date: Tue, 2 Sep 2025 15:55:01 +1200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7176ab..fe5f2ff 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # dshash -Simple SHA256 hashing library and example utility \ No newline at end of file +Simple SHA256 hashing library and example utility + +## dshash C++ class + +- located in src/ +- A simple implementation of SHA256 with no dependencies. +- Just two files: dshash.cpp and dshash.hpp +- can hash a file, directory tree, or string. +- uses std::array as the underlying type +- generally used as a std::string, containing the hex representation of the hash. + +## dshash utility + +- located in dshash/ +- no dependencies, statically linked +- simple command line utilty to calculate hash of file or directory +- outputs the hash only with a newline +- -v (verbose) mode lists the individual files as they are processed. + +# testing + +- testing of both the C++ class and the dshash utility are in tests/ +- ./test.sh runs all tests and returns success only if all pass. + +# publishing +- dshash utility published as a getpkg.xyz package, and also available from getbin.xyz. +