Skip to content

chore: rearrange/edit README #374

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
Merged
merged 3 commits into from
Feb 21, 2020
Merged

chore: rearrange/edit README #374

merged 3 commits into from
Feb 21, 2020
+285 −285

Conversation

broofa
Copy link
Member

@broofa broofa commented Feb 21, 2020

Did and edit pass on the README. Specifically:

  • Updated the features list at the top
  • Moved Quick Start to the top, since that is what most people are going to be interested in.
  • Move release notes to the bottom. Kept a "Upgrading to uuid@3?" line at the top directing people to them, however.
  • Renamed all "v3.x"-style uuid version references to "uuid@3" to minimize confusion between RFC UUID "version" and uuid module version. I.e Don't use "version" to refer to anything but RFC UUID version.
  • Unicode warning symbols as html entity char codes (prefer not having actual unicode chars in source). Also, the "⚠️ ⚠️ ⚠️ ... WARNING HERE ...⚠️ ⚠️ ⚠️" felt a bit excessive. 😄

@broofa broofa requested a review from ctavan February 21, 2020 18:50
ctavan
ctavan requested changes Feb 21, 2020
View reviewed changes
Copy link
Member

@ctavan ctavan left a comment

Choose a reason for hiding this comment

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

Thanks for the cleanup, definitely increases understandability!

Just a few nits…

@ctavan
Copy link
Member

ctavan commented Feb 21, 2020

Also, I just merged #373 and a rebase is now necessary, sorry!

@broofa
Copy link
Member Author

broofa commented Feb 21, 2020

Failing test is unrelated. Merging.

@broofa broofa merged commit 8260002 into master Feb 21, 2020
@broofa broofa deleted the readme_cleanup branch February 21, 2020 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ctavan ctavan

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

Successfully merging this pull request may close these issues.

None yet
2 participants
@broofa @ctavan