Contents

# SushiYakuza

sushi_yakuza is a gem that converts sushi names from hiragana or katakana to kanji and kanji to hiragana.
You can use it for Sushi Kanji quiz etc.

## Installation

Install the gem and add to the application's Gemfile by executing:

    $ bundle add sushi_yakuza

If bundler is not being used to manage dependencies, install the gem by executing:

    $ gem install sushi_yakuza

## Usage

```ruby
# Hiragana or Kakatana => Kanji
SushiYakuza.to_kanji('あなご')
SushiYakuza.to_kanji('アナゴ')
# return '穴子'

# Kanji => Hiragana
SushiYakuza.to_hiragana('穴子')
# return 'あなご'

# If you enter a sushi that does not exist
SushiYakuza.to_kanji('りんご')
SushiYakuza.to_hiragana('林檎')
# return false
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sushi_yakuza. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sushi_yakuza/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the SushiYakuza project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sushi_yakuza/blob/master/CODE_OF_CONDUCT.md).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
sushi_yakuza-0.1.1	README.md
sushi_yakuza-0.1.0	README.md