# Human Readable ID Generator

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/jshmrtn/human_readable_identifier_generator/master/LICENSE)
![.github/workflows/elixir.yml](https://github.com/jshmrtn/human_readable_identifier_generator/workflows/.github/workflows/elixir.yml/badge.svg)
[![Hex.pm Version](https://img.shields.io/hexpm/v/human_readable_identifier_generator.svg?style=flat)](https://hex.pm/packages/human_readable_identifier_generator)
[![Coverage Status](https://coveralls.io/repos/github/jshmrtn/human_readable_identifier_generator/badge.svg?branch=master)](https://coveralls.io/github/jshmrtn/human_readable_identifier_generator?branch=master)

Present ID's to humans that are readable and writeable.

## Installation

Add `human_readable_identifier_generator` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [{:human_readable_identifier_generator, "~> 1.0"}]
end
```

## Usage

Please look into the [Documentation](https://hexdocs.pm/human_readable_identifier_generator/) for usage examples.