Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

readme updates

  • Loading branch information...
commit 1bcaa959234f027271cf852fa59587fe126be444 1 parent 930231f
@maddox maddox authored
Showing with 14 additions and 0 deletions.
  1. +14 −0 README.textile
View
14 README.textile
@@ -4,8 +4,22 @@ h2. What?
A simple Ruby library to talk to "GiantBomb":http://www.giantbomb.com
+It's super simple right now. All it can do is search games and return the shallow details.
+
h2. How?
+<pre><code>
+require 'giant_bomb'
+gb = GiantBomb::Search.new("api_key")
+results = gb.find_game('Halo 3: ODST')
+
+halo = results.first
+
+halo.name => "Halo 3: ODST"
+halo.image[:super] => "http://media.giantbomb.com/uploads/1/14735/1101733-20090611232449_halo_3_odst_box_art_super.png"
+
+</code></pre>
+
h2. Install
gem install giant_bomb
Please sign in to comment.
Something went wrong with that request. Please try again.