README.md in impas-client-0.0.2 vs README.md in impas-client-0.0.3
- old
+ new
@@ -1,23 +1,9 @@
# Impas::Client
-TODO: Write a gem description
+Impas::Client is a Ruby interface for Impas API.
-## Synopsys
-
-```ruby
-require 'impas-client'
-client = Impas::Client.new({
- api_url:"http://local.impas-hideack.sqale.jp/",
- op_key:"4109b1be1e6a08b9f0b7ef2fa84c3e20"
-})
-
-client.add_group "foobar" # 集計グループ追加
-client.groups # 登録中のグループ一覧取得
-
-```
-
## Installation
Add this line to your application's Gemfile:
gem 'impas-client'
@@ -30,10 +16,26 @@
$ gem install impas-client
## Usage
-TODO: Write usage instructions here
+```ruby
+require 'impas-client'
+
+client = Impas::Client.new({
+ api_url:"http://impas.****.jp/",
+ op_key:"*****"
+})
+
+client.add_group "sample_group1" # 集計グループ追加
+client.groups # 登録中のグループ一覧取得
+
+client.add_url( # URLを集計対象へ追加
+ "051fc80bff3afd1db52bfc3dae8f6329",
+ "http://www.youtube.com/watch?v=2HQkugdXyHY"
+)
+
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)