README.md in gimei-0.0.1 vs README.md in gimei-0.1.0
- old
+ new
@@ -1,26 +1,14 @@
# Gimei
[](https://travis-ci.org/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 は名前のふりがな(及びフリガナ)に対応しています。
-## Installation
-Add this line to your application's Gemfile:
-
- gem 'gimei'
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install gimei
-
## Usage
下記のように使います。
```ruby
@@ -34,13 +22,27 @@
gimei.first.kanji #=> "陽菜"
gimei.first.hiragana #=> "はるな"
gimei.first.katakana #=> "ハルナ"
```
-漢字、ひらがな、カタカナどれか一種類だけ取得できればよい場合には、下記のように書くことも出来ます。
+下記のように男性／女性の名前を返すことを明示的に指定できます。`Gimei.new` の場合は男女の名前を等確率で返します。
```ruby
+gimei = Gimei.male
+gimei.male? #=> true
+gimei.female? #=> false
+gimei.kanji #=> "小林 顕士"
+
+gimei = Gimei.female
+gimei.male? #=> false
+gimei.female? #=> true
+gimei.kanji #=> "根本 彩世"
+```
+
+漢字、ひらがな、カタカナどれか一種類だけ取得できればよい場合には、下記のように短縮して書くことも出来ます。
+
+```ruby
Gimei.kanji #=> "伊藤 結衣"
Gimei.hiragana #=> "いとう みさき"
Gimei.katakana #=> "タカハシ ユイナ"
Gimei.last.kanji #=> "清水"
Gimei.last.hiragana #=> "いとう"
@@ -49,9 +51,23 @@
Gimei.first.hiragana #=> "ここあ"
Gimei.first.katakana #=> "ヤマト"
```
出力される名前の候補となるデータは `lib/data/names.yml` にあるので、必要であればファイルを修正してください。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+ gem 'gimei'
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install gimei
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)