sloanelybutsurely/typeid-elixir
1
0
Fork 0
mirror of https://github.com/sloanelybutsurely/typeid-elixir.git synced 2024-11-28 01:42:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

publish 0.0.1

Browse source
This commit is contained in:
Sloane Perrault 2023-06-30 07:24:59 -04:00
parent ea6de20944
commit 3337d6b2cd
No known key found for this signature in database
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -2,19 +2,20 @@
[![CI](https://github.com/sloanelybutsurely/typeid-elixir/actions/workflows/ci.yaml/badge.svg)](https://github.com/sloanelybutsurely/typeid-elixir/actions/workflows/ci.yaml)
Read the full documentation on [hexdocs](https://hexdocs.pm/typeid_elixir/TypeID.html)
### 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.
## Installation
The package can be installed by adding `typeid` to your list of dependencies in
`mix.exs`:
The package can be installed from [hex](https://hex.pm/packages/typeid_elixir) by adding `typeid_elixir` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:typeid, "~> 0.1.0"}
{:typeid_elixir, "~> 0.0.1"}
]
end
```

2
mix.exs
View file

@ -4,7 +4,7 @@ defmodule TypeID.MixProject do
def project do
[
app: :typeid_elixir,
version: "0.1.0",
version: "0.0.1",
elixir: "~> 1.15",
start_permanent: Mix.env() == :prod,
description: description(),