From 37e1cbeddda0aca5f10fe8bfa308f6c98233813c Mon Sep 17 00:00:00 2001 From: Michael Roth Date: Thu, 31 Oct 2024 14:34:22 +0100 Subject: [PATCH] Release 1.0.1 - simplified ULID generation code --- Cargo.toml | 2 +- README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 847c500..4594c7c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "mr-ulid" description = "Robust and Hassle-Free ULIDs (Universally Unique Lexicographically Sortable Identifier)" -version = "1.0.0" +version = "1.0.1" edition = "2021" categories = ["encoding", "data-structures", "web-programming"] diff --git a/README.md b/README.md index 0d04078..236b2ba 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,12 @@ By providing both `Ulid` and `ZeroableUlid` types, it serves different applicati - **Minimal Dependencies**: Actually no dependencies required, only `rand` enabled by default as Rust lacks a built-in random number generator. - **Optional Features**: Supports `serde` for serialization and deserialization. +## Guarantees + +A notable feature of this crate is the guarantee that a sufficient number of ULIDs can be generated at any time without failing or the random part overflowing. + +The 80-bit random component of a ULID is slightly reduced by 1010 values, resulting in a negligible reduction in entropy of approximately 0.000000000001%. This ensures that at least 1010 ULIDs can be generated per _millisecond_, equating to 1013 ULIDs per _second_. Such capacity exceeds the capabilities of current systems by magnitudes. + ## Installation Add `mr-ulid` to your `Cargo.toml`: @@ -93,12 +99,6 @@ fn main() { } ``` -## Guarantees - -A notable feature of this crate is the guarantee that a sufficient number of ULIDs can be generated at any time without failing or the random part overflowing. - -The 80-bit random component of a ULID is slightly reduced by 1010 values, resulting in a negligible reduction in entropy of approximately 0.000000000001%. This ensures that at least 1010 ULIDs can be generated per _millisecond_, equating to 1013 ULIDs per _second_. Such capacity exceeds the capabilities of current systems by magnitudes. - ## Contributing Contributions are welcome! Whether it's a bug fix, new feature, or improvement, your help is appreciated. Please feel free to open issues or submit pull requests on the [GitHub repository](https://github.com/mrothNET/mr-ulid).