README.md in rakuten_web_service-0.2.2 vs README.md in rakuten_web_service-0.2.3
- old
+ new
@@ -1,56 +1,63 @@
# RakutenWebService
-[](https://travis-ci.org/satoryu/rakuten_web_service) [](http://badge.fury.io/rb/rakuten_web_service)
+[](https://travis-ci.org/rakuten-ws/rws-ruby-sdk) [](http://badge.fury.io/rb/rakuten_web_service)
-## Installation
+rakuten\_web\_serviceは、 Rubyから楽天が提供しているAPIに簡単にアクセスできるSDK(Software Development Kit)です。
-Add this line to your application's Gemfile:
+English version is [here](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.en.md).
+## インストール方法
+
+bundlerを利用したアプリケーションの場合、Gemfileに以下の1行を追加します。
+
```ruby
gem 'rakuten_web_service'
```
-And then execute:
+そして`bundle`コマンドでインストール。
$ bundle
-Or install it yourself as:
+もしくは、`gem`コマンドにより
$ gem install rakuten_web_service
-## Usage
+とすることでインストールできます。
+## 使用方法
+
Now rakuten\_web\_service is supporting the following APIs:
+現在rakuten\_web\_serviceは下記のAPIをサポートしています。
* [Rakuten Ichiba Item Search API](http://webservice.rakuten.co.jp/api/ichibaitemsearch/)
* [Rakuten Ichiba Genre Search API](http://webservice.rakuten.co.jp/api/ichibagenresearch/)
* [Rakuten Ichiba Ranking API](http://webservice.rakuten.co.jp/api/ichibaitemranking/)
-### Configuration
+### 設定
-`RakutenWebService.configuration` allows you to specify your application's key called application\_id and your affiliate id(optional).
+`RakutenWebService.configuration` メソッドを使い、Application IDとAffiliate ID（オプション）を指定することができます。
```ruby
RakutenWebService.configuration do |c|
c.application_id = YOUR_APPLICATION_ID
c.affiliate_id = YOUR_AFFILIATE_ID
end
```
-### Search Ichiba Items
+### 市場商品の検索
```ruby
items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enamerable object
items.first(10).each do |item|
puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.
end
```
-### Genre
+### ジャンル
-Genre class provides an interface to traverse sub genres.
+Genreクラスは、`children`や`parent`といったジャンル階層を辿るインターフェースを持っています。
```ruby
root = RakutenWebService::Ichiba::Genre.root # root genre
# children returns sub genres
root.children.each do |child|
@@ -60,14 +67,14 @@
# Use genre id to fetch genre object
RakutenWebService::Ichiba::Genre[100316].name # => "水・ソフトドリンク"
```
-### Ichiba Item Ranking
+### 市場商品ランキング
```ruby
- RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 0) # returns the TOP 30 items for Male in 30s
- RakutenWebService::Ichiba::Genre[100316].ranking # the TOP 30 items in "水・ソフトドリンク" genre
+ RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 0) # 30代男性 のランキングTOP 30
+ RakutenWebService::Ichiba::Genre[100316].ranking # "水・ソフトドリンク" ジャンルのTOP 30
```
## Contributing
1. Fork it