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 readme to document experimental v6 and v7 ids #94

Merged
merged 2 commits into from Dec 10, 2021

Conversation

cameracker
Copy link
Contributor

@cameracker cameracker commented Nov 3, 2021

Updates README to call out experimental v6 and v7 uuid generation functions.

Copy link

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated
* 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.

README.md Outdated Show resolved Hide resolved
@cameracker cameracker merged commit 028e840 into master Dec 10, 2021
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.

None yet

3 participants