Update README.md
This commit is contained in:
44
README.md
44
README.md
@@ -19,11 +19,45 @@ Simple SHA256 hashing library and example utility
|
||||
- outputs the hash only with a newline
|
||||
- -v (verbose) mode lists the individual files as they are processed.
|
||||
|
||||
# testing
|
||||
# Installation
|
||||
|
||||
- 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.
|
||||
## Quick install (recommended)
|
||||
|
||||
# publishing
|
||||
- dshash utility published as a getpkg.xyz package, and also available from getbin.xyz.
|
||||
```bash
|
||||
curl https://getbin.xyz/dshash-install | bash
|
||||
```
|
||||
|
||||
## Manual download
|
||||
|
||||
```bash
|
||||
# For x86_64
|
||||
curl -L -o dshash https://getbin.xyz/dshash:latest-x86_64
|
||||
|
||||
# For arm64/aarch64
|
||||
curl -L -o dshash https://getbin.xyz/dshash:latest-aarch64
|
||||
|
||||
chmod +x dshash
|
||||
```
|
||||
|
||||
## Using getpkg
|
||||
|
||||
```bash
|
||||
getpkg install dshash
|
||||
```
|
||||
|
||||
# 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
|
||||
- Comprehensive test suite includes:
|
||||
- Unit tests for the library
|
||||
- System sha256sum comparison
|
||||
- NIST test vectors validation
|
||||
- Stress tests and edge cases
|
||||
- Performance benchmarks
|
||||
|
||||
# Publishing
|
||||
|
||||
- dshash utility published as a getpkg.xyz package, and also available from getbin.xyz
|
||||
- Automated CI/CD via Gitea Actions for linux/amd64 and linux/arm64
|
||||
|
||||
|
Reference in New Issue
Block a user