README.md in odesk-api-0.1.0 vs README.md in odesk-api-0.1.1
- old
+ new
@@ -1,9 +1,12 @@
Ruby bindings for oDesk API
============
[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](http://badge.fury.io/rb/odesk-api)
+[](https://travis-ci.org/odesk/ruby-odesk)
+[](http://waffle.io/odesk/ruby-odesk)
# Odesk::Api
This project provides a set of resources of oDesk API from http://developers.odesk.com
based on OAuth 1.0a.
@@ -44,10 +47,16 @@
## SLA
The usage of this API is ruled by the Terms of Use at:
http://developers.odesk.com/API-Terms-of-Use
+# Application Integration
+To integrate this library you need to have:
+
+* Ruby >= 1.9.3
+* OAuth Extension installed (use `gem install oauth`)
+
## Installation
Add this line to your application's Gemfile:
gem 'odesk-api'
@@ -60,6 +69,11 @@
$ gem install odesk-api
## Usage
-TODO: Write usage instructions here
+1.
+Follow instructions from `Installation` section.
+
+2.
+Open `myapp.rb` and type the `consumer_key` and `consumer_secret` that you previously got from the API Center.
+***That's all. Run your app as `ruby myapp.rb` and have fun.***'