Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanwinchester committed Apr 19, 2024
1 parent 11752d8 commit cdb23e1
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,13 @@ to add additional sort precision to a version 7 UUID.

- You want sequential, time-based, ordered IDs (per-node).
- You are willing to trade a small amount of raw performance for these
guarantees. You are taking a hit for backwards time-leap protection and the
counter with rollover protection.
guarantees. You are taking a hit for the counter with rollover protection,
and backwards time-leap protection.

NOTE: In this library, sequential UUIDs and ordering are more important than time precision and performance.
We take a slight hit in both of those areas to ensure that the UUIDs are in order. For example, in the case of a
backwards time leap, we continue with the previously used timestamp, and in the case of rollover, we increment
the timestamp by one to ensure that the ordering is maintained.

## When should I not use this package?

Expand Down

0 comments on commit cdb23e1

Please sign in to comment.