README.md in gimei-0.1.0 vs README.md in gimei-0.2.0
- old
+ new
@@ -1,20 +1,23 @@
# Gimei
[](https://travis-ci.org/willnet/gimei)
+[](https://coveralls.io/r/willnet/gimei)
[](http://badge.fury.io/rb/gimei)
[](https://coderwall.com/willnet)
-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 ふりがな(及びフリガナ)に対応しています。
-## Usage
+## 使い方
+### 名前をランダムで返す
+
下記のように使います。
```ruby
-gimei = Gimei.new
+gimei = Gimei.name
gimei.kanji #=> "斎藤 陽菜"
gimei.hiragana #=> "さいとう はるな"
gimei.katakana #=> "サイトウ ハルナ"
gimei.last.kanji #=> "斎藤"
gimei.last.hiragana #=> "さいとう"
@@ -22,11 +25,11 @@
gimei.first.kanji #=> "陽菜"
gimei.first.hiragana #=> "はるな"
gimei.first.katakana #=> "ハルナ"
```
-下記のように男性／女性の名前を返すことを明示的に指定できます。`Gimei.new` の場合は男女の名前を等確率で返します。
+下記のように男性／女性の名前を返すことを明示的に指定できます。`Gimei.name` の場合は男女の名前を等確率で返します。
```ruby
gimei = Gimei.male
gimei.male? #=> true
gimei.female? #=> false
@@ -51,9 +54,56 @@
Gimei.first.hiragana #=> "ここあ"
Gimei.first.katakana #=> "ヤマト"
```
出力される名前の候補となるデータは `lib/data/names.yml` にあるので、必要であればファイルを修正してください。
+
+### 住所をランダムで返す
+
+バージョン0.2.0からは、住所情報も取得できるようになりました。都道府県、区、市、町を組み合わせた住所情報を漢字、ひらがな、カタカナで取得することができます。
+
+```ruby
+address = Gimei.address
+address.kanji # => 岡山県大島郡大和村稲木町
+address.to_s # => 岡山県大島郡大和村稲木町
+address.hiragana # => おかやまけんおおしまぐんやまとそんいなぎちょう
+address.katakana # => オカヤマケンオオシマグンヤマトソンイナギチョウ
+
+address.prefecture.kanji # => 岡山県
+address.prefecture.to_s # => 岡山県
+address.prefecture.hiragana # => おかやまけん
+address.prefecture.katakana # => オカヤマケン
+
+address.city.kanji # => 大島郡大和村
+address.city.to_s # => 大島郡大和村
+address.city.hiragana # => おおしまぐんやまとそん
+address.city.katakana # => オオシマグンヤマトソン
+
+address.town.kanji # => 稲木町
+address.town.to_s # => 稲木町
+address.town.hiragana # => いなぎちょう
+address.town.katakana # => イナギチョウ
+```
+
+省略形も用意しています。
+
+```ruby
+Gimei.prefecture.kanji # => 青森県
+Gimei.prefecture.to_s # => 滋賀県
+Gimei.prefecture.hiragana # => やまがたけん
+Gimei.prefecture.katakana # => チバケン
+
+Gimei.city.kanji # => 利根郡昭和村
+Gimei.city.hiragana # => うべし
+Gimei.city.katakana # => カモグンヤオツチョウ
+
+Gimei.town.kanji # => 竹野
+Gimei.town.to_s # => 富久山町南小泉
+Gimei.town.hiragana # => じょうしんでん
+Gimei.town.katakana # => イケナイ
+```
+
+出力される住所の候補となるデータは `lib/data/addresses.yml` にあるので、必要であればファイルを修正してください。
## Installation
Add this line to your application's Gemfile: