Speller 0.1.8

Speller 0.1.8

×

TestsTested ✗
LangLanguage SwiftSwift
License MIT
ReleasedLast Release Aug 2018
SPMSupports SPM ✓

Maintained by Jean-Étienne.

Speller 0.1.8

Speller

Build Status GitHub license GitHub release codecov.io Carthage compatible CocoaPods Compatible Platform

Spelling out words using known spelling alphabets

Speller helps you spell out words using know spelling alphabets. When you're on the phone trying to spell a difficult word, or when you want to sound like you're a pilot.

Features

Speller spells out words for you using any of the provided spelling alphabets. At the moment you can choose among the following spelling alphabets:

  • International Radiotelephony
  • US Financial
  • LAPD
  • Czech
  • Danish
  • Dutch
  • Finnish
  • French
  • German
  • Italian
  • Norwegian
  • Portuguese
  • Brazilian Portuguese
  • Slovene
  • Spanish
  • Swedish
  • Turkish
  • PGP Word List

If a letter is not found in the spelling alphabet, a minimum description of the character is provided, based on:

  • Emoji description
  • Basic Latin
  • Latin 1 Supplement
  • Latin Extended A
  • Latin Extended B

The most famous spelling alphabet is probably the InternationalRadiotelephony, also know as the NATO alphabet.

Usage

Use the Speller class to spell a word, using one of the spelling alphabets:

  Speller.spell(phrase: "Bagpipe", withSpellingAlphabet: .InternationalRadiotelephony)

The returned value is an array of spelled characters with their corresponding codewords:

  let spelling = Speller.spell(phrase: "Bagpipe", withSpellingAlphabet: .InternationalRadiotelephony)
  print(spelling)
  // [B: Bravo, a: Alfa, g: Golf, p: Papa, i: India, p: Papa, e: Echo]

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Speller into your Xcode project using CocoaPods, specify it in your Podfile:

  pod 'Speller'

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Speller into your Xcode project using Carthage, specify it in your Cartfile:

github "jeanetienne/Speller"

Run carthage update to build the framework and drag the built Speller.framework into your Xcode project.

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate Speller into your project manually.