README.md



# phonetic

[![Package Version](https://img.shields.io/hexpm/v/test)](https://hex.pm/packages/gleam_phonetic)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/phonetic_gleam/)

A handy collection of algorithms dealing with phonetics. 

## 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 gleam_phonetic
```

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