README.md

romkan-elm

Romkan is a library to convert between Japanese Romaji and Kana.

This is an Elm port of the Haskell port of the Python port of Ruby/Romkan.

Usage

$ elm package install spect88/romkan-hs

import Romkan

Romkan.toHiragana "kekkou" -- => "けっこう" : String

Development

To run the tests:

$ npm install elm-test -g
$ elm test

To test documentation:

$ elm make --docs=documentation.json

Then upload generated documentation.json file to documentation preview.