Browse files

README Update

  • Loading branch information...
1 parent 8310812 commit 1136be65ce78f8c0e6147f57a18cf706efaab5fd @esparkman committed Mar 30, 2012
Showing with 6 additions and 3 deletions.
  1. +6 −3 README.md
View
9 README.md
@@ -2,6 +2,8 @@
Assist is a simple API handler for Dribbble.
+<b>This is not a production ready gem. Please use at your own risk.</b>
+
## Installation
Add this line to your application's Gemfile:
@@ -18,9 +20,9 @@ Or install it yourself as:
## Usage
-Simple case use would be to load irb/pry. Then do a require 'Assist'.
+Simple case use would be to load irb/pry. Then require 'Assist'.
-Retrieving a Player Profile:
+<b>Retrieving a Player Profile:</b>
player = Assist::Player.new('simplebits') # username being the name of the user you wish to pull JSON data for.
@@ -32,7 +34,8 @@ player.name
Any fields that is returned in the JSON data can be pulled dynamically from the player Object.
-Retrieving a Players Shots:
+<hr />
+<b>Retrieving a Players Shots:</b>
player = Assist::Player.new('simplebits') # username being the name of the user you wish to pull JSON data for.

0 comments on commit 1136be6

Please sign in to comment.