README.rdoc in 3scale_client-2.2.8 vs README.rdoc in 3scale_client-2.2.9
- old
+ new
@@ -1,7 +1,11 @@
-= Client for 3scale web service management system API
+= Rubygem for 3scale Web Service Management API
+{<img src="https://secure.travis-ci.org/3scale/3scale_ws_api_for_ruby.png?branch=master" alt="Build Status" />}[http://travis-ci.org/3scale/3scale_ws_api_for_ruby]
+
+3scale is an API Infrastructure service which handles API Keys, Rate Limiting, Analytics, Billing Payments and Developer Management. Includes a configurable API dashboard and developer portal CMS. More product stuff at http://www.3scale.net/, support information at http://support.3scale.net/.
+
== Installation
This library is distributed as a gem:
gem install 3scale_client
@@ -9,17 +13,17 @@
Or alternatively, download the source code from github:
http://github.com/3scale/3scale_ws_api_for_ruby
If you are using Bundler, please add this to your Gemfile:
- gem '3scale_client', :require => '3scale/client'
+ gem '3scale_client'
and do a bundle install.
If you are using Rails' config.gems, put this into your config/environment.rb
- config.gem "3scale_client", :lib => '3scale/client'
+ config.gem '3scale_client
Otherwise, require the gem in whatever way is natural to your framework of choice.
== Usage
@@ -82,11 +86,11 @@
=== OAuth Authorize
To authorize an application with OAuth, call the +oauth_authorize+ method passing it the application's id.
- response = client.authorize(:app_id => "the app id")
+ response = client.oauth_authorize(:app_id => "the app id")
If the authorization is successful, the response will contain the +app_key+ and +redirect_url+ defined for this application:
response.app_key
response.redirect_url
@@ -125,10 +129,5 @@
In case of error, the +error_code+ returns system error code and +error_message+
human readable error description:
response.error_code # "provider_key_invalid"
response.error_message # "provider key \"foo\" is invalid"
-
-== Legal
-
-Copyright (c) 2010 3scale networks S.L., released under the MIT license.
-