Update README with SHA3 algorithm details and version bump to 1.5#13
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #13 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 359 359
=========================================
Hits 359 359 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates project metadata and documentation for the SHA3 family and releases version 1.5.
Changes:
- Added SHA3-224/256/384/512 to the README algorithm table and selection guidance.
- Expanded README with per-variant SHA3 documentation and usage examples.
- Bumped the project version from 1.4 to 1.5 in CMake and Conan metadata.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Documents SHA3 variants, updates algorithm table/selection guide, and adds usage examples. |
| conanfile.py | Bumps Conan package version to 1.5. |
| CMakeLists.txt | Bumps CMake project version to 1.5. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the library to version 1.5 and adds support for the full SHA3 family of cryptographic hash functions. The documentation is expanded to explain the new SHA3 algorithms, their use cases, and how to use them in code.
New SHA3 algorithm support and documentation:
README.md.README.mdwith detailed sections for each SHA3 variant, including example usage code and guidance on when to use each algorithm.README.mdto clarify that SHA3 algorithms also returnstd::array<std::byte, N>.README.mdto include recommendations for the new SHA3 algorithms.Version bump:
CMakeLists.txtandconanfile.pyto reflect the new features. [1] [2]