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

docs: minimal README

Browse source
This commit is contained in:
Sloane Perrault 2023-06-29 17:38:33 -04:00
parent aa0251fdd1
commit fd9431991d
No known key found for this signature in database
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,11 +1,13 @@
# TypeID
# TypeID Elixir
**TODO: Add description**
### 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
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `typeid` to your list of dependencies in `mix.exs`:
The package can be installed by adding `typeid` to your list of dependencies in
`mix.exs`:
```elixir
def deps do
@ -15,7 +17,3 @@ def deps do
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/typeid>.