README更新

Author: polidog

README.md

@@ -3,46 +3,81 @@ php-chatwork-api
 
 [![Build Status](https://travis-ci.org/polidog/php-chatwork-api.png?branch=develop)](https://travis-ci.org/polidog/php-chatwork-api)
 [![Coverage Status](https://coveralls.io/repos/polidog/php-chatwork-api/badge.png)](https://coveralls.io/r/polidog/php-chatwork-api)
-[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/badges/quality-score.png?s=56ea782f70ecfbe3de485e4be2a2c585455e44e3)](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/)  
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/badges/quality-score.png?s=56ea782f70ecfbe3de485e4be2a2c585455e44e3)](https://scrutinizer-ci.com/g/polidog/php-chatwork-api/)
+[![Latest Stable Version](https://poser.pugx.org/polidog/php-chatwork-api/v/stable.svg)](https://packagist.org/packages/polidog/php-chatwork-api)
+[![Total Downloads](https://poser.pugx.org/polidog/php-chatwork-api/downloads.svg)](https://packagist.org/packages/polidog/php-chatwork-api)
+[![License](https://poser.pugx.org/polidog/php-chatwork-api/license.svg)](https://packagist.org/packages/polidog/php-chatwork-api)
 
+[Chatwork](http://www.chatwork.com/ja/) APIをPHPから利用するためのライブラリです。
 
-みんな大好きChatWorkのAPIの限定プレビューが始まるということで、早速先走ってAPIラッパークラスをPHPで実装してみました。
-まだAPIの使えない僕は、妄想しながら実装したので、動くかどうかは責任とれませんw
+## 必要
+- PHP5.5+
 
 
-## インストール方法
+## Install
 
+composer.jsonに以下の記述を加えてください。
 
-1\. composer.pharを用意します。  
 ```
-$ curl -sS https://getcomposer.org/installer | php
+{
+  "require": {
+    "polidog/php-chatwork-api": "0.2.*@dev"
+  }
+}
 ```
-2\. comoposer.jsonを用意しましょう
+
+
+## Quick Example
+
+利用する前に必ずChatWorkのAPIキーを用意しておいてください。  
+[APIキーの確認方法](http://developer.chatwork.com/ja/authenticate.html)を確認してください。
+
+### オブジェクトを取得する
 
 ```
-{
-    "require": {
-        "polidog/php-chatwork-api": "dev-develop",
-        "kriswallsmith/buzz": "v0.10"
-    }
-}
+// ChatWork API Clientオブジェクトの初期化
+$client = new \Polidog\Chatwork\Client("chatwork api token");
+```
+
+### 自分自身の情報(APIキーの所有者)
 
 ```
-3\. インストール
+$user = $client->api('me')->show();
 
+// APIのレスポンスはすべてオブジェクトの形で取得できます
+var_dump($user);
 ```
-php composer.phar install
+
+### チャットルーム一覧を取得する
+
+```
+$rooms = $client->api('rooms')->show();
+var_dump($rooms);
 ```
 
-4\. 実際につかってみる
+### チャットルームを作成する
+ここちょっと面倒くさい感じになってしまってます。。
+
 ```
-<?php
-require './vendor/autoload.php';
+// まずはRoomクラスを用意する
+$room = new \Polidog\Chatwork\Entity\Room();
+$room->name = 'test chat';
 
-$client = new \Chatwork\Client();
-$client->authenticate('your api key');
-//var_dump($client->api('me')->show());
-//var_dump($client->api('my')->status());
-var_dump($client->api('my')->tasks());
+// 次にメンバー一覧を用意する
+$members = new \Polidog\Chatwork\Entity\Collection\MembersCollection();
+$member = new \Polidog\Chatwork\Entity\Member();
+$member->role = 'admin';
+$member->account = $user;
+$members->add($member);
+```
+
+### チャットルームのメンバー一覧を取得する
+```
+$members = $client->api('rooms')->members(123456/* roomidを指定します。*/);
+var_dump($members);
+
+```
 
 
+## 関連リンク
+- [ChatWork API](http://developer.chatwork.com/ja/)