Skip to content

Commit

Permalink
More work on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adriandulic committed Feb 8, 2011
1 parent 3dd61a2 commit 94a26c0
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
@@ -1,15 +1,19 @@
BitsOnTheRun
==============

BitsOnTheRun is an implementation of [bitsontherun.com](bitsontherun.com) API in Ruby.
BitsOnTheRun is an implementation of [bitsontherun.com](http://bitsontherun.com) API in Ruby.

## Install

Gemfile:
Just run the following command:

gem install bitsontherun

Then in your Gemfile add the following line:

gem 'bitsontherun'

Run:
And finally run:

bundle install

Expand All @@ -21,15 +25,16 @@ Add in _config/initializers/bitsontherun.rb_ file:

## Usage

Basic:
Basic call:

BitsOnTheRun::call('version') => {:status => "ok", :version => "X.X.X"}

BitsOnTheRun::store('videos/create', 'video.mp4') => {:status => "ok", ...}

BitsOnTheRun::call('videos/update', :video_key => 'your video key', :title => 'New title for video').ok? => true

Extended:
Basic store:

BitsOnTheRun::store('videos/create', 'video.mp4') => {:status => "ok", ...}

Extended call methods:

call = BitsOnTheRun::API.new(:call)
call.method('videos/list')
Expand All @@ -43,6 +48,8 @@ Extended:
call.method('videos/update', :video_key => 'your video key', :title => 'New title for video')
call.execute

Extended store methods:

call = BitsOnTheRun::API.new(:store)
call.method('videos/create')
call.file('video.mp4')
Expand Down Expand Up @@ -81,3 +88,4 @@ Find methods:
response.videos => [<BitsOnTheRun::Response>, <BitsOnTheRun::Response>, ...]
response.videos.first => <BitsOnTheRun::Response>
repsonse.videos.first.title => "Video title"

0 comments on commit 94a26c0

Please sign in to comment.