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.

Sign up for GitHub

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

Jump to bottom

docs: update README for v11 #784

Merged
merged 1 commit into from
Jul 22, 2024
Merged

docs: update README for v11 #784

merged 1 commit into from
Jul 22, 2024

Conversation

broofa
Copy link
Member

@broofa broofa commented Jul 22, 2024 •
edited
Loading

Updating README for v11 release.

  • Added verbiage to alert readers to the breaking changes (options handling, byte array types)
  • Removed old verbiage about past bugs and issues prior to v9. (This stuff took up a lot of space and only applied to a vanishingly small contingent of readers.)
  • Update examples to use Uint8Array type instead of Arrays.

@broofa broofa changed the title docs: update for v11 docs: update README for v11 Jul 22, 2024
@broofa broofa merged commit b08c122 into main Jul 22, 2024
12 checks passed
@broofa broofa deleted the v11_readme branch July 22, 2024 23:33
@tstackhouse
Copy link

(This stuff took up a lot of space and only applied to a vanishingly small contingent of readers.)

I'm one of those vanishingly small readers who just got this error message today and had to dig in the git history to find the relevant fix.

@broofa
Copy link
Member Author

broofa commented Jul 27, 2024

@tstackhouse What issue? Which part of the README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ctavan ctavan ctavan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@broofa @tstackhouse @ctavan