Update README.md for v2.5.0 #422
Merged
Conversation
This file contains 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
Remove "Disclaimers" section. Update "Acknowledgments" section. Update Quick Start.
|
@x448 please take a look when you have a moment. 🙏 |
x448
reviewed
Aug 13, 2023
| @@ -17,7 +17,7 @@ See [Quick Start](#quick-start). | |||
| [](https://github.com/fxamacker/cbor/actions/workflows/codeql-analysis.yml) | |||
| [](#fuzzing-and-code-coverage) | |||
| [](https://goreportcard.com/report/github.com/fxamacker/cbor) | |||
| [](#) <!-- Do not open PR for this. For now, don't go to detailed report. --> | |||
| [](https://github.com/fxamacker/cbor#fuzzing-and-code-coverage) | |||
x448
reviewed
Aug 13, 2023
README.md
Outdated
|
|
||
| ## Acknowledgements | ||
| I'm extremely grateful for people who were supportive or contributed in the very early days: | ||
| - Stefan Tatschner, Yawning Angel, Jernej Kos, ZenGround0, Montgomery Edwards⁴⁴⁸, Jakob Borg |
There was a problem hiding this comment.
Thanks! 😄 Feel free to use x448 if you want the text to be shorter.
x448
reviewed
Aug 13, 2023
README.md
Outdated
| @@ -352,7 +356,7 @@ Decoder checks for all required well-formedness errors, including all "subkinds" | |||
|
|
|||
| After well-formedness is verified, basic validity errors are handled as follows: | |||
|
|
|||
| * Invalid UTF-8 string: Decoder always checks and returns invalid UTF-8 string error. | |||
| * Invalid UTF-8 string: Decoder checks and returns invalid UTF-8 string error by default. | |||
There was a problem hiding this comment.
Sounds a bit awkward because "by default" was added to the end.
x448
approved these changes
Aug 13, 2023
Good point.
I want to release tag v2.5.0 today (Sunday, Aug 13). Can you update benchmarks in the "Status" section today? If not, I can do that. This is not a blocker because it needs click to view. |
x448
approved these changes
Aug 13, 2023
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.
Changes:
This PR and #421 closes #420