Permalink
Browse files

Updated README.md with simple use case

  • Loading branch information...
1 parent e977324 commit b5c84055636c2d37c766cfb4526a697ac110535d Evan Sparkman committed Mar 29, 2012
Showing with 11 additions and 1 deletion.
  1. +11 −1 README.md
View
12 README.md
@@ -18,7 +18,17 @@ Or install it yourself as:
## Usage
-TODO: Write usage instructions here
+Simple case use would be to load irb/pry. Then do a require 'Assist'.
+
+player = Assist::Player.new('simplebits') # username being the name of the user you wish to pull JSON data for.
+
+player.username
+=> "simplebits"
+
+player.name
+=> "Dan Cedarholm"
+
+Any fields that is returned in the JSON data can be pulled dynamically from the player Object.
## Contributing

0 comments on commit b5c8405

Please sign in to comment.