gs-uuid/README.md
Pat Garrity 4c4beb8d18
All checks were successful
/ Build and Test Library Snapshot (pull_request) Successful in 1m40s
Consistency, Docs, and QOL Improvements
- Fixed consistency around `()` use.
- Added `toBytes()` and `fromBytes(Array[Byte])`.
- Added missing ScalaDoc.
- Updated tests.
- Updated all dependencies to latest.
2024-08-01 08:47:35 -05:00

43 lines
976 B
Markdown

# gs-uuid
[GS Open Source](https://garrity.co/oss.html) |
[License (Apache 2.0)](./LICENSE)
UUIDs for Scala 3 with generation based on JUG, and serialization based on code
from Jackson Databind. The only dependency is JUG, whereas the relevant Jackson
code is copied to this implementation (and slightly modified).
- [Usage](#usage)
- [Dependency](#dependency)
- [Donate](#donate)
## Usage
### Dependency
This artifact is available in the Garrity Software Maven repository.
```scala
externalResolvers +=
"Garrity Software Releases" at "https://maven.garrity.co/releases"
val GsUuid: ModuleID =
"gs" %% "gs-uuid-v0" % "$VERSION"
```
### Type
```scala
import gs.uuid.v0.UUID
given UUID.Generator = UUID.Generator.version7
val id = UUID.generate()
println(id.str()) // 292c9bc70d0f4d998053d7b2f72cd9b7
```
## Donate
Enjoy this project or want to help me achieve my [goals](https://garrity.co)?
Consider [Donating to Pat on Ko-fi](https://ko-fi.com/gspfm).