Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update intro and cbor quick start in README #421

Merged
merged 12 commits into from
Aug 7, 2023

Conversation

fxamacker
Copy link
Owner

@fxamacker fxamacker commented Aug 6, 2023

Updates #420

Update README for v2.5.0

  • Rewrite Quick Start
  • Update intro to show Struct Tags and CBOR Security earlier.
  • Removed sections: "Comparison", "Usage", "Why fxamacker/cbor", "CBOR Options", "API", etc.
  • Removed files: CBOR_GOLANG.md, CBOR_BENCHMARKS.md, etc.
  • Update CODE_OF_CONDUCT.md
  • Add openssf scorecard badge but did not link to detailed report.
  • Make Acknowledgements section placeholder because new contributors weren't included for years. (need to fix!)

Update intro, quick start, and removed sections such as "Usage" because it was too redundant or outdated.
@fxamacker fxamacker self-assigned this Aug 6, 2023
@fxamacker
Copy link
Owner Author

@x448 Can you take a look when you have a moment? 🙏

@fxamacker fxamacker added the docs label Aug 6, 2023
Removed:
- "Why fxamacker/cbor"
- CBOR Security

Most of this info is already in the intro.
Remove "CBOR Options" section.

This info can be found in the docs and it looks like it was outdated here.
Removed "API", "Go Struct Tags", and "Options" sections.
Copy link
Contributor

@x448 x448 left a comment

Choose a reason for hiding this comment

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

Amazing work! Quick start looks great!

Design and Feature Highlights looks a bit weird. Maybe too long or something else?

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@fxamacker fxamacker requested a review from x448 August 7, 2023 04:03
Copy link
Contributor

@x448 x448 left a comment

Choose a reason for hiding this comment

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

Fantastic improvement!

@fxamacker fxamacker merged commit 837230c into master Aug 7, 2023
13 checks passed
@fxamacker fxamacker deleted the fxamacker/update-readme-intro-quickstart-for-v2.5.0 branch December 28, 2023 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants