Skip to content

Update README with SHA3 algorithm details and version bump to 1.5#13

Merged
rwindegger merged 3 commits into
mainfrom
feature/update-readme
Apr 3, 2026
Merged

Update README with SHA3 algorithm details and version bump to 1.5#13
rwindegger merged 3 commits into
mainfrom
feature/update-readme

Conversation

@rwindegger

Copy link
Copy Markdown
Owner

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:

  • Added SHA3-224, SHA3-256, SHA3-384, and SHA3-512 hash algorithms to the library and documented their output types, digest sizes, and use cases in the algorithm comparison table in README.md.
  • Expanded the README.md with detailed sections for each SHA3 variant, including example usage code and guidance on when to use each algorithm.
  • Updated the digest formatting section in README.md to clarify that SHA3 algorithms also return std::array<std::byte, N>.
  • Updated the algorithm selection guide in README.md to include recommendations for the new SHA3 algorithms.

Version bump:

  • Bumped the project version to 1.5 in both CMakeLists.txt and conanfile.py to reflect the new features. [1] [2]

@codecov

codecov Bot commented Apr 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (aca3bc3) to head (5ecf2ed).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
@rwindegger rwindegger merged commit 62bdcfb into main Apr 3, 2026
9 checks passed
@rwindegger rwindegger deleted the feature/update-readme branch April 3, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants