README.rdoc in dribble-0.0.2 vs README.rdoc in dribble-0.0.3
- old
+ new
@@ -1,25 +1,27 @@
= Dribble
-This is the unofficial dribble api.
+This is the unofficial dribble api. For more examples look in the examples/ directory. There are examples for the both styles (object notation and hash implementation.)
-There is a very thin wrapper for the Dribble API that is labeled as Dribble::API. This uses the bare minimum to get the desired data from Dribble and returns a symbolized hash. This implementation is focused on simplicity and speed. However, I have yet to really work on the speed aspect.
-
== Dribble::API
+There is a very thin wrapper for the Dribble API that is labeled as Dribble::API. This uses the bare minimum to get the desired data from Dribble and returns a hash. This implementation is focused on simplicity and speed. However, I have yet to really work on the speed aspect.
+
Dribble::API::Player.profile('simplebits')
Dribble::API::Shot.popular
-Dribble::Player and Dribble::Shot is another layer on-top of the API to add that object look and feel. This is more for convenience and ease of use.
-
-This is meant for convenience and ease of use.
-
-
== Dribble::Player && Dribble::Shot
- Dribble::Player.find('simplebits')
+Dribble::Player and Dribble::Shot is another layer on-top of the API to add that object look and feel. This is more for convenience and ease of use.
+
+This is meant for convenience and ease of use.
+
Dribble::Shot.popular
+
+ player = Dribble::Player.profile('simplebits')
+ player.following # => the shots that this player is following
+ player.shots # => the players shots
== Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.