Docs/readme refresh - #87
Merged
mattia-moffa merged 1 commit intoSep 16, 2026
Merged
Conversation
aidangarske
requested review from
mattia-moffa
and
a lite review from Copilot
September 15, 2026 21:11
There was a problem hiding this comment.
🟡 Changes recommended
Resolve the README’s RFC, benchmark-scope, countersignature wording, and algorithm-count inconsistencies.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Refreshes the README structure and presentation.
Changes:
- Reorganized standards, features, algorithms, and performance information.
- Added footprint and throughput tables.
- Updated dependency and CI wording.
File summaries
| File | Summary |
|---|---|
| README.md | Updated project overview, feature lists, algorithms, benchmarks, and dependency details. |
Review details
Suppressed comments (2)
README.md:20
- This broadens the countersignature claim from the previous “all six tagged” message types to “all message types,” but the APIs only accept tagged COSE messages (
include/wolfcose/wolfcose.h:1241-1301) and the following README section still documents that restriction. Please keep the “tagged” qualifier here.
* **V2 Countersignatures (RFC 9338):** Full and abbreviated in-place countersignatures across all message types.
README.md:25
- The refreshed feature list says there are 41 algorithms, while the unchanged release-notes paragraph later in this same README still says 40.
docs/Algorithms.mdalso identifies 41, so this landing page now contradicts itself; update the stale release-notes count as part of this refresh.
* **41 Cryptographic Algorithms:** Broad algorithm coverage across signing, encryption, MAC, and key distribution.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
mattia-moffa
approved these changes
Sep 16, 2026
aidangarske
force-pushed
the
docs/readme-refresh-20260915
branch
from
September 16, 2026 16:31
7831a89 to
608d526
Compare
mattia-moffa
approved these changes
Sep 16, 2026
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.
Update readme overview to look a little better on the eyes.