Skip to content

Improve README.md examples#111

Merged
yogeshbdeshpande merged 1 commit intoveraison:mainfrom
qmuntal:readme
Nov 4, 2022
Merged

Improve README.md examples#111
yogeshbdeshpande merged 1 commit intoveraison:mainfrom
qmuntal:readme

Conversation

@qmuntal
Copy link
Copy Markdown
Member

@qmuntal qmuntal commented Oct 10, 2022

This PR updates the examples in the README.md to make it clear that the errors should be handled someway and also clarify hash function requirements.

Fixes #106

Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 10, 2022

Codecov Report

Merging #111 (ebe4891) into main (66f9d81) will increase coverage by 2.04%.
The diff coverage is 100.00%.

❗ Current head ebe4891 differs from pull request most recent head e30ab45. Consider uploading reports for the commit e30ab45 to get more accurate results

@@            Coverage Diff             @@
##             main     #111      +/-   ##
==========================================
+ Coverage   89.74%   91.79%   +2.04%     
==========================================
  Files          10       10              
  Lines         985      975      -10     
==========================================
+ Hits          884      895      +11     
+ Misses         67       54      -13     
+ Partials       34       26       -8     
Impacted Files Coverage Δ
headers.go 92.14% <100.00%> (-1.15%) ⬇️
signer.go 100.00% <0.00%> (ø)
ed25519.go 100.00% <0.00%> (ø)
verifier.go 100.00% <0.00%> (ø)
sign.go 88.93% <0.00%> (+1.03%) ⬆️
sign1.go 86.86% <0.00%> (+1.75%) ⬆️
algorithm.go 100.00% <0.00%> (+3.44%) ⬆️
ecdsa.go 95.89% <0.00%> (+19.32%) ⬆️
rsa.go 100.00% <0.00%> (+25.00%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Copy Markdown
Contributor

@thomas-fossati thomas-fossati left a comment

Choose a reason for hiding this comment

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

🚢 it!

@qmuntal
Copy link
Copy Markdown
Member Author

qmuntal commented Nov 4, 2022

@yogeshbdeshpande can you take a look at this?

Copy link
Copy Markdown
Contributor

@yogeshbdeshpande yogeshbdeshpande left a comment

Choose a reason for hiding this comment

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

LGTM!

@qmuntal
Copy link
Copy Markdown
Member Author

qmuntal commented Nov 4, 2022

I don't have merge permissions, need someone to do that for me :)

@yogeshbdeshpande yogeshbdeshpande merged commit 77e3f9f into veraison:main Nov 4, 2022
@yogeshbdeshpande
Copy link
Copy Markdown
Contributor

Done! and Thank you for the Excellent Work!

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.

Update Readme Examples

3 participants