Skip to content

Commit 48e34fa

Browse files
committed
docs: update example and README.md
1 parent f3ab6a3 commit 48e34fa

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Go Reference](https://pkg.go.dev/badge/github.com/cmackenzie1/go-uuid.svg)](https://pkg.go.dev/github.com/cmackenzie1/go-uuid)
44
![go workflow](https://github.com/cmackenzie1/go-uuid/actions/workflows/go.yml/badge.svg)
55

6-
A simple, stdlib only, go module for generating UUIDs (**U**niversally **U**nique **ID**entifiers).
6+
A simple, stdlib only, go module for generating version 4 (random) and version 7 (time-based) UUIDs (**U**niversally **U**nique **ID**entifiers). This library is based on the [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) specification.
77

88
## Installation
99

@@ -62,7 +62,7 @@ func main() {
6262
### What are the benefits of this library over X?
6363

6464
- A single library with no external dependencies for multiple types of UUIDs.
65-
- `UUID` type is defined as a fixed-size, `[16]byte`, array which can be used as a map (instead of the 36 byte
65+
- `UUID` type is defined as a fixed-size, `[16]byte`, array which can be used as a map key (instead of the 36 byte
6666
string representation). Over 2x space savings for memory!
6767
- Limited API. As per RFC9562, UUIDs (while containing embedded information), should be treated as opaque
6868
values. There is no temptation to build dependencies on the embedded information if you can't easily access it. 😉
@@ -88,4 +88,4 @@ Please make sure to update tests as appropriate.
8888

8989
[MIT](./LICENSE.md)
9090

91-
[1]: https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-01.html#section-2.1
91+
[1]: https://www.rfc-editor.org/rfc/rfc9562.html#section-2.1

example/example.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ func main() {
1313
}
1414
fmt.Printf("UUIDv4: %s\n", v4) // c07526de-40e5-418f-93d1-73ba20d2ac2c
1515

16-
v7, _ := uuid.NewV7()
16+
v7, err := uuid.NewV7()
1717
if err != nil {
1818
panic(err)
1919
}

0 commit comments

Comments
 (0)