README.md in hockeyhelper-0.0.2 vs README.md in hockeyhelper-0.0.3

- old
+ new

@@ -1,10 +1,11 @@ -# Hockey +# hockeyhelper gem -Helper gem for HokceyApp API +Helper gem for HokceyApp API. [![Build Status](https://travis-ci.org/yagihiro/hockey.svg?branch=master)](https://travis-ci.org/yagihiro/hockey) +[![Gem Version](https://badge.fury.io/rb/hockeyhelper.svg)](http://badge.fury.io/rb/hockeyhelper) ## Installation Add this line to your application's Gemfile: @@ -18,10 +19,45 @@ $ gem install hockeyhelper ## Usage -TODO: Write usage instructions here +create a new app and an invite user + + require 'hockeyhelper' + client = Hockey::Client.new 'yourapitoken' + app = client.new_app(title: appname, bundle_identifier: bundleid, platform: platform) + user = app.invite_user(email: email) + +list all apps with paging + + require 'hockeyhelper' + client = Hockey::Client.new 'yourapitoken' + apps = client.apps(page: 1) + +list all versions for an app + + require 'hockeyhelper' + client = Hockey::Client.new 'yourapitoken' + versions = client.apps(page: 1)[0].versions + +list all users for an app + + require 'hockeyhelper' + client = Hockey::Client.new 'yourapitoken' + users = client.apps(page: 1)[0].users + +remove a user from an app + + require 'hockeyhelper' + client = Hockey::Client.new 'yourapitoken' + client.apps(page: 1)[0].remove_user 'email@xxx.xx' + +list all teams with paging + + require 'hockeyhelper' + client = Hockey::Client.new 'yourapitoken' + teams = client.teams(page: 1) ## Contributing 1. Fork it ( https://github.com/[my-github-username]/hockey/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)