README.md in gimei-0.2.0 vs README.md in gimei-0.3.0
- old
+ new
@@ -1,60 +1,66 @@
# Gimei
-[](https://travis-ci.org/willnet/gimei)
-[](https://coveralls.io/r/willnet/gimei)
-[](http://badge.fury.io/rb/gimei)
-[](https://coderwall.com/willnet)
+[](https://travis-ci.org/willnet/gimei)
+[](https://coveralls.io/r/willnet/gimei)
+[](https://codeclimate.com/github/willnet/gimei)
+[](https://rubygems.org/gems/gimei)
-gimei は、日本人の名前や、日本の住所をランダムに返すライブラリです。テストの時などに使います。似たようなライブラリに[faker](https://github.com/stympy/faker)があります。[faker](https://github.com/stympy/faker)はとても優れたライブラリで、多言語対応もしていますが、ふりがな(フリガナ)は流石に対応していません。gimei ふりがな(及びフリガナ)に対応しています。
+gimei は、日本人の名前や、日本の住所をランダムに返すライブラリです。テストの時などに使います。似たようなライブラリに[faker](https://github.com/stympy/faker)があります。[faker](https://github.com/stympy/faker)はとても優れたライブラリで、多言語対応もしていますが、ふりがな(フリガナ)は流石に対応していません。gimei はふりがな(及びフリガナ)に対応しています。
## 使い方
### 名前をランダムで返す
下記のように使います。
```ruby
gimei = Gimei.name
-gimei.kanji #=> "斎藤 陽菜"
-gimei.hiragana #=> "さいとう はるな"
-gimei.katakana #=> "サイトウ ハルナ"
-gimei.last.kanji #=> "斎藤"
-gimei.last.hiragana #=> "さいとう"
-gimei.last.katakana #=> "サイトウ"
-gimei.first.kanji #=> "陽菜"
+gimei.kanji #=> "斎藤 陽菜"
+gimei.hiragana #=> "さいとう はるな"
+gimei.katakana #=> "サイトウ ハルナ"
+gimei.romaji #=> "Haruna Saitou"
+gimei.last.kanji #=> "斎藤"
+gimei.last.hiragana #=> "さいとう"
+gimei.last.katakana #=> "サイトウ"
+gimei.last.romaji #=> "Saitou"
+gimei.first.kanji #=> "陽菜"
gimei.first.hiragana #=> "はるな"
gimei.first.katakana #=> "ハルナ"
+gimei.first.romaji #=> "Haruna"
```
下記のように男性／女性の名前を返すことを明示的に指定できます。`Gimei.name` の場合は男女の名前を等確率で返します。
```ruby
gimei = Gimei.male
-gimei.male? #=> true
+gimei.male? #=> true
gimei.female? #=> false
-gimei.kanji #=> "小林 顕士"
+gimei.kanji #=> "小林 顕士"
gimei = Gimei.female
-gimei.male? #=> false
+gimei.male? #=> false
gimei.female? #=> true
-gimei.kanji #=> "根本 彩世"
+gimei.kanji #=> "根本 彩世"
```
-漢字、ひらがな、カタカナどれか一種類だけ取得できればよい場合には、下記のように短縮して書くことも出来ます。
+漢字、ひらがな、カタカナ、ローマ字どれか一種類だけ取得できればよい場合には、下記のように短縮して書くことも出来ます。
```ruby
-Gimei.kanji #=> "伊藤 結衣"
-Gimei.hiragana #=> "いとう みさき"
-Gimei.katakana #=> "タカハシ ユイナ"
-Gimei.last.kanji #=> "清水"
-Gimei.last.hiragana #=> "いとう"
-Gimei.last.katakana #=> "コバヤシ"
-Gimei.first.kanji #=> "結菜"
+Gimei.kanji #=> "伊藤 結衣"
+Gimei.hiragana #=> "いとう みさき"
+Gimei.katakana #=> "タカハシ ユイナ"
+Gimei.romaji #=> "Miki Obara"
+Gimei.last.kanji #=> "清水"
+Gimei.last.hiragana #=> "いとう"
+Gimei.last.katakana #=> "コバヤシ"
+Gimei.last.romaji #=> "Wakabayashi"
+Gimei.first.kanji #=> "結菜"
Gimei.first.hiragana #=> "ここあ"
Gimei.first.katakana #=> "ヤマト"
+Gimei.first.romaji #=> "Noriyuki"
```
出力される名前の候補となるデータは `lib/data/names.yml` にあるので、必要であればファイルを修正してください。
### 住所をランダムで返す
@@ -65,45 +71,70 @@
address = Gimei.address
address.kanji # => 岡山県大島郡大和村稲木町
address.to_s # => 岡山県大島郡大和村稲木町
address.hiragana # => おかやまけんおおしまぐんやまとそんいなぎちょう
address.katakana # => オカヤマケンオオシマグンヤマトソンイナギチョウ
+address.romaji # => Okayamaken Ooshimagunyamatoson Inagicho
address.prefecture.kanji # => 岡山県
address.prefecture.to_s # => 岡山県
address.prefecture.hiragana # => おかやまけん
address.prefecture.katakana # => オカヤマケン
+address.prefecture.romaji # => Okayamaken
address.city.kanji # => 大島郡大和村
address.city.to_s # => 大島郡大和村
address.city.hiragana # => おおしまぐんやまとそん
address.city.katakana # => オオシマグンヤマトソン
+address.city.romaji # => Ooshimagunyamatoson
address.town.kanji # => 稲木町
address.town.to_s # => 稲木町
address.town.hiragana # => いなぎちょう
address.town.katakana # => イナギチョウ
+address.town.romaji # => Inagicho
```
省略形も用意しています。
```ruby
Gimei.prefecture.kanji # => 青森県
Gimei.prefecture.to_s # => 滋賀県
Gimei.prefecture.hiragana # => やまがたけん
Gimei.prefecture.katakana # => チバケン
+Gimei.prefecture.romaji # => Wakayamaken
Gimei.city.kanji # => 利根郡昭和村
Gimei.city.hiragana # => うべし
Gimei.city.katakana # => カモグンヤオツチョウ
+Gimei.city.romaji # => Itanogunaizumichou
Gimei.town.kanji # => 竹野
Gimei.town.to_s # => 富久山町南小泉
Gimei.town.hiragana # => じょうしんでん
Gimei.town.katakana # => イケナイ
+Gimei.town.romaji # => Heisei
```
出力される住所の候補となるデータは `lib/data/addresses.yml` にあるので、必要であればファイルを修正してください。
+
+## Supported versions
+
+- 1.9.3
+- 2.0.0
+- 2.1.x
+- 2.2.x
+- 2.3.x
+- 2.4.x
+
+## 他言語による実装
+
+- [mattn/go-gimei](https://github.com/mattn/go-gimei)
+- [moznion/gimei-java](https://github.com/moznion/gimei-java)
+- [nabetama/gimei](https://github.com/nabetama/gimei)
+- [gongo/emacs-gimei](https://github.com/gongo/emacs-gimei)
+- [ma2gedev/gimei_ex](https://github.com/ma2gedev/gimei_ex)
+- [demiglacesource/node-gimei](https://github.com/demiglacesource/node-gimei)
## Installation
Add this line to your application's Gemfile: