Romajify

Build Status Coverage Status Code Climate Dependency Status Inline docs License

Japanese romanization library for Ruby.

Installation

Add this line to your application's Gemfile:

gem 'romajify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install romajify

Usage

Command Line Interface

$ romajify hepburn すし

Ruby Source Code

require 'romajify/converter'
puts Romajify::Converter.hepburn('すし')

Supported Romaji

Hepburn Romaji

Modified Hepburn:

$ romajify hepburn しんばし
# => shinbashi

Traditional Hepburn:

$ romajify hepburn --traditional しんばし
# => shimbashi

Nihon-shiki Romaji

$ romajify nihon まちづくり
# => matidukuri

Kunrei-shiki Romaji

$ romajify kunrei まちづくり
# => matizukuri

Contributing

  1. Fork it ( https://github.com/emsk/romajify/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

MIT