Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.16 KB

README.markdown

File metadata and controls

34 lines (22 loc) · 1.16 KB

Romajinizer

A gem for helping you convert between Japanese hiragana, katakana, and Roman romaji alphabets. Please note that this gem is not used for converting kanji (libraries such as MeCab would be much more beneficial)

Usage

Getting Started

gem install romajinizer

Examples

Check out romajinizer_spec.rb under the spec/ folder for clear examples on how to best use this library.

Contributing to romajinizer

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2011 Joe Ellis. See LICENSE.txt for further details.