Contents

# Romajic

[![Build Status](https://travis-ci.org/emsk/romajic.svg?branch=master)](https://travis-ci.org/emsk/romajic)
[![Coverage Status](https://coveralls.io/repos/github/emsk/romajic/badge.svg?branch=master)](https://coveralls.io/github/emsk/romajic)
[![Code Climate](https://codeclimate.com/github/emsk/romajic/badges/gpa.svg)](https://codeclimate.com/github/emsk/romajic)
[![Dependency Status](https://gemnasium.com/emsk/romajic.svg)](https://gemnasium.com/emsk/romajic)
[![Inline docs](http://inch-ci.org/github/emsk/romajic.svg?branch=master)](http://inch-ci.org/github/emsk/romajic)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)

Automatic romaji spelling checker for programmer.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'romajic'
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install romajic
```

## Usage

Give hiragana text:

```sh
$ romajic search すし
SUSI -> sushi @ /usr/local/src/Example.java:5
sushiya -> sushi @ /usr/local/src/example.txt:2
```

Give romaji text:

```sh
$ romajic search sushi
SUSI -> sushi @ /usr/local/src/Example.java:5
sushiya -> sushi @ /usr/local/src/example.txt:2
```

## Command Options

| Option | Description |
| :----- | :---------- |
| `-e/--exclude-word` | Word to exclude. |
| `-c/--config` | Path of configuration file. |
| `-d/--dir` | Path of target directory. |
| `-E/--extensions` | Comma-separated target extensions. |
| `-D/--distance` | Levenshtein distance. |
| `-C/--converter` | Romaji converter, such as `hepburn`, `modified_hepburn`, `traditional_hepburn`, `nihon`, or `kunrei`. |

## Contributing

1. Fork it ( https://github.com/emsk/romajic/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](LICENSE.txt)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
romajic-0.1.0	README.md