# gxid

![CI](https://github.com/defgenx/gxid/workflows/test/badge.svg?branch=master)
[![Package Version](https://img.shields.io/hexpm/v/gxid)](https://hex.pm/packages/gxid)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gxid/)

A Gleam implementation of xid

## Task List
- [x] Write xid generator and encode
- [x] Write tests
- [x] Write xid decode
- [ ] Implement a prefix feature

## Quick start

```sh
gleam run   # Run the project
gleam test  # Run the tests
gleam shell # Run an Erlang shell
```

## Installation

If available on Hex this package can be added to your Gleam project:

```sh
gleam add gxid
```

and its documentation can be found at <https://hexdocs.pm/gxid>.