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

update readme to document experimental v6 and v7 ids #94

Merged
merged 2 commits into from Dec 10, 2021
Merged

update readme to document experimental v6 and v7 ids #94

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d1ce26
update readme to document experimental v6 and v7 ids
cameracker Nov 3, 2021
dfed585
Update README.md
cameracker Dec 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -16,6 +16,14 @@ This package supports the following UUID versions:
* Version 4, based on random numbers (RFC-4122)
* Version 5, based on SHA-1 hashing of a named value (RFC-4122)

This package also supports experimental Universally Unique Identifier implementations based on a
[draft RFC](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format) that updates RFC-4122
* Version 6, a k-sortable id based on timestamp (draft-peabody-dispatch-new-uuid-format, RFC-4122)
* Version 7, a k-sortable id based on timestamp with variable precision (draft-peabody-dispatch-new-uuid-format, RFC-4122)

The v6 and v7 IDs are **not** considered a part of the stable API, and may be subject to behavior or API changes as part of minor releases
to this package. They will be updated as the draft RFC changes, and will become stable if and when the draft RFC is adopted into RFC-4122
Copy link
Member

Choose a reason for hiding this comment

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

will become stable if and when the draft RFC is adopted into RFC-4122

I'm not sure it'll become part of 4122. It may be more accurate to say something like:

will become stable if and when the draft RFC is accepted.

cameracker marked this conversation as resolved.
Show resolved Hide resolved

## Project History

This project was originally forked from the
Expand Down