spellout 0.1.1

A phonetic code encoder/decoder
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

---
date: 2024-07-09
title: ":house: Home"
---

{{< keywordList markdownify="true" >}}
[![crates.io](https://img.shields.io/badge/crates.io-v0.1.1-orange.svg?logo=rust)](https://crates.io/crates/spellout)
  [![License](https://img.shields.io/badge/License-MIT-information.svg)](https://github.com/tamada/spellout/blob/master/LICENSE)
[![Version](https://img.shields.io/badge/Version-v0.1.1-information.svg)](https://github.com/tamada/spellout/releases/tag/v0.1.1)

[![build](https://github.com/tamada/spellout/actions/workflows/build.yaml/badge.svg)](https://github.com/tamada/spellout/actions/workflows/build.yaml)
[![Coverage Status](https://coveralls.io/repos/github/tamada/spellout/badge.svg?branch=main)](https://coveralls.io/github/tamada/spellout?branch=main)
[![Rust Report Card](https://rust-reportcard.xuri.me/badge/github.com/tamada/spellout)](https://rust-reportcard.xuri.me/report/github.com/tamada/spellout)
{{< /keywordList >}}

## :speaking_head: Description

`spellout` is a Rust library and command-line tool for converting text into various phonetic codes, also known as spelling alphabets. It supports a wide range of predefined alphabets like the NATO phonetic alphabet, as well as custom alphabets defined by the user.

## Features

- **Dual Functionality**: Usable as both a command-line tool (`spellout`) and a Rust library.
- **Wide Range of Alphabets**: Comes with many predefined phonetic alphabets, including international and country-specific ones.
- **Customizable**: Create your own phonetic alphabets by providing a base alphabet with substitutions or by loading definitions from a file.
- **Unicode Normalization**: Optional feature to normalize input strings for consistent conversion.
- **Simple & Fast**: Lightweight and designed for quick conversions.

## Demo