typeid-elixir/README.md

23 lines
696 B
Markdown
Raw Normal View History

2023-06-29 17:38:33 -04:00
# TypeID Elixir
2023-06-29 15:20:23 -04:00
2023-06-29 17:38:33 -04:00
### A type-safe, K-sortable, globally unique identifier inspired by Stripe IDs
[TypeIDs](https://github.com/jetpack-io/typeid) are a modern, type-safe, globally unique identifier based on the upcoming UUIDv7 standard. They provide a ton of nice properties that make them a great choice as the primary identifiers for your data in a database, APIs, and distributed systems. Read more about TypeIDs in their spec.
2023-06-29 15:20:23 -04:00
## Installation
2023-06-29 17:38:33 -04:00
The package can be installed by adding `typeid` to your list of dependencies in
`mix.exs`:
2023-06-29 15:20:23 -04:00
```elixir
def deps do
[
{:typeid, "~> 0.1.0"}
]
end
```
2023-06-30 06:50:00 -04:00
## Spec
The original TypeID spec is defined [here](https://github.com/jetpack-io/typeid).