Skip to content

Commit d081ab8

Browse files
committed
docs: update readme
1 parent e4dd7f4 commit d081ab8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ UUID
55
[![Current release](https://img.shields.io/github/v/release/FossoresLP/uuid?display_name=tag&sort=semver)](https://github.com/FossoresLP/uuid/releases)
66
[![Documentation](https://img.shields.io/badge/Docs-pkg.go.dev-blue)](https://pkg.go.dev/github.com/fossoreslp/uuid)
77

8-
This package implements the UUID versions defined in [RFC4122bis](https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-02.html).
8+
This package implements the UUID versions defined in [RFC9562](https://www.ietf.org/rfc/rfc9562.html).
99

10-
Versions 1 through 5 are defined in the original [RFC4122](https://www.ietf.org/rfc/rfc4122.html), while versions 6 through 8 are new additions.
10+
Versions 1 through 5 are unchanged from the original [RFC4122](https://www.ietf.org/rfc/rfc4122.html), while versions 6 through 8 are new additions.
1111

12-
Versions 6 and 7 are designed as timestamp-based, sortable IDs for use e.g. in database indexes. Version 7 is recommended for new applications while version 6 is a sortable replacement for version 1.
12+
Versions 6 and 7 are designed as timestamp-based, sortable IDs for use e.g. in database indexes. Version 7 is recommended for new applications and drops the node id for random data making it unguessable and more collision resistant, while version 6 is a sortable replacement for version 1.
1313

1414
Version 8 is highly customizable, allowing for 122 custom bits with only version and variant being predefined.
1515

16-
Create a new UUID: `uuid.NewVx() (UUID, error)`
16+
Create a new UUID: `uuid.NewVx() UUID`
1717

1818
Convert an UUID to a string: `UUID.String() string`
1919

@@ -25,4 +25,4 @@ Check if UUID contains only zeros: `UUID.IsNil() bool`
2525

2626
Check if UUID contains only ones: `UUID.IsMax() bool`
2727

28-
Support for `encoding.Text(Un)Marshaler`, `encoding.Binary(Un)Marshaler`, `database/sql.Scanner` and `database/sql/driver.Valuer` is built in, so the IDs can be used with most data exchange formats and databases.
28+
Support for `fmt.Stringer`, `encoding.Text(Un)Marshaler`, `encoding.Binary(Un)Marshaler`, `database/sql.Scanner` and `database/sql/driver.Valuer` is built in, so the IDs can be used with most data exchange formats and databases and print in the canonical format by default.

0 commit comments

Comments
 (0)