Permalink
Browse files

A bit more readme...

  • Loading branch information...
1 parent 2b3c6ab commit cc9162a57e88ee61023c90adb8805924f43728f3 @jnunemaker jnunemaker committed Nov 10, 2011
Showing with 14 additions and 1 deletion.
  1. +14 −1 README.rdoc
View
@@ -2,7 +2,20 @@
Ruby gem that gives you easy access to the Gaug.es API.
-More coming soon, when it actually does something...
+== Usage
+
+ # List the titles of your gauges
+ client = Gauges.new(:token => '...')
+ client.gauges.each do |gauge|
+ puts gauge['title']
+ end
+
+ client.content(gauge_id) # first page of top content
+ client.content(gauge_id, :page => 2) # second page of top content
+
+More examples in the examples directory of the repository.
+
+https://github.com/orderedlistinc/gauges-gem/tree/master/examples
== Note on Patches/Pull Requests

0 comments on commit cc9162a

Please sign in to comment.