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

docs: add note about cypto.randomUUID() #686

Merged
merged 1 commit into from
Feb 12, 2023

Conversation

jonkoops
Copy link
Contributor

@jonkoops jonkoops commented Feb 6, 2023

Closes #682

@@ -32,7 +32,11 @@ For the creation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) UUIDs
- **Small** - Zero-dependency, small footprint, plays nice with "tree shaking" packagers
- **CLI** - Includes the [`uuid` command line](#command-line) utility

**Upgrading from `uuid@3`?** Your code is probably okay, but check out [Upgrading From `uuid@3`](#upgrading-from-uuid3) for details.
> **Note**
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This applies some special GitHub flavored markdown to visualize the notes:

Note
Upgrading from uuid@3? Your code is probably okay, but check out Upgrading From uuid@3 for details.

Note
Only interested in creating a version 4 UUID? You might be able to use cypto.randomUUID(), eliminating the need to install this library.

Copy link
Member

Choose a reason for hiding this comment

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

Cool! I didn't know about this

Copy link
Member

@LinusU LinusU left a comment

Choose a reason for hiding this comment

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

Changes looks good 👍

Could you run npm run docs so that the rendered readme is also updated?

@jonkoops jonkoops changed the title Add note about cypto.randomUUID() docs: add note about cypto.randomUUID() Feb 9, 2023
@jonkoops jonkoops requested a review from LinusU February 9, 2023 22:35
@jonkoops
Copy link
Contributor Author

jonkoops commented Feb 9, 2023

@LinusU Done 👍

Copy link
Member

@LinusU LinusU left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@broofa broofa merged commit aef75d7 into uuidjs:main Feb 12, 2023
@broofa
Copy link
Member

broofa commented Feb 12, 2023

@jonkoops Thanks for the help!

@jonkoops jonkoops deleted the random-uuid-note branch February 12, 2023 19:43
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.

Start recommending Web Crypto API for RFC version 4?
3 participants