From 9120efea8a7b1f9c1feddf150ce6bdb78c8b81d3 Mon Sep 17 00:00:00 2001 From: Bradley Grainger Date: Sat, 5 Oct 2024 09:25:16 -0700 Subject: [PATCH] Update README. --- README.md | 16 ++++++++-------- src/NGuid/README.md | 14 +++++++------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 93ca924..8f5eb76 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,21 @@ ## About -NGuid provides efficient creation of name-based and random GUIDs according to +NGuid provides efficient creation of name-based, time-based, and random GUIDs according to [RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122) -and [RFC 9562](https://datatracker.ietf.org/doc/html/rfc9562):: +and [RFC 9562](https://datatracker.ietf.org/doc/html/rfc9562): -* Version 3 - created from an MD5 hash of a name -* Version 5 - created from a SHA1 hash of a name -* Version 6 - a field-compatible version of UUIDv1, reordered for improved DB locality -* Version 7 - a time-ordered value based on a Unix timestamp -* Version 8 - an RFC-compatible format for experimental or vendor-specific use cases +* Version 3 ‒ created from an MD5 hash of a name +* Version 5 ‒ created from a SHA1 hash of a name +* Version 6 ‒ a field-compatible version of UUIDv1, reordered for improved DB locality +* Version 7 ‒ a time-ordered value based on a Unix timestamp +* Version 8 ‒ an RFC-compatible format for experimental or vendor-specific use cases ## Usage ```csharp // returns a "Version 5" UUID by default: {74738ff5-5367-5958-9aee-98fffdcd1876} -var guid = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8); +var guidv5 = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8); // can also create "Version 3": {0012416f-9eec-3ed4-a8b0-3bceecde1cd9} var guidv3 = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8, version: 3); diff --git a/src/NGuid/README.md b/src/NGuid/README.md index 4736a58..2726ad4 100644 --- a/src/NGuid/README.md +++ b/src/NGuid/README.md @@ -1,20 +1,20 @@ ## NGuid -NGuid provides efficient creation of name-based and random GUIDs according to +NGuid provides efficient creation of name-based, time-based, and random GUIDs according to [RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122) and [RFC 9562](https://datatracker.ietf.org/doc/html/rfc9562): -* Version 3 - created from an MD5 hash of a name -* Version 5 - created from a SHA1 hash of a name -* Version 6 - a field-compatible version of UUIDv1, reordered for improved DB locality -* Version 7 - a time-ordered value based on a Unix timestamp -* Version 8 - an RFC-compatible format for experimental or vendor-specific use cases +* Version 3 ‒ created from an MD5 hash of a name +* Version 5 ‒ created from a SHA1 hash of a name +* Version 6 ‒ a field-compatible version of UUIDv1, reordered for improved DB locality +* Version 7 ‒ a time-ordered value based on a Unix timestamp +* Version 8 ‒ an RFC-compatible format for experimental or vendor-specific use cases ## Usage ```csharp // returns a "Version 5" UUID by default: {74738ff5-5367-5958-9aee-98fffdcd1876} -var guid = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8); +var guidv5 = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8); // can also create "Version 3": {0012416f-9eec-3ed4-a8b0-3bceecde1cd9} var guidv3 = GuidHelpers.CreateFromName(GuidHelpers.DnsNamespace, "www.example.org"u8, version: 3);