Skip to content

Commit

Permalink
update readme to document experimental v6 and v7 ids (#94)
Browse files Browse the repository at this point in the history
* update readme to document experimental v6 and v7 ids

* Update README.md
  • Loading branch information
cameracker committed Dec 10, 2021
1 parent 0c84a43 commit 028e840
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
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 accepted.

## Project History

This project was originally forked from the
Expand Down

0 comments on commit 028e840

Please sign in to comment.