Readme.md in foursquare2-0.9.0 vs Readme.md in foursquare2-0.9.1
- old
+ new
@@ -12,11 +12,11 @@
Currently this gem does not handle the oauth2 authentication flow for you, use the [oauth2 gem](https://github.com/intridea/oauth2) to retrieve and store oauth tokens for a user. Obtain your client key/secret for userless access at the [foursquare developer site.](https://foursquare.com/oauth/)
### Instantiate a client (Userless Access)
- client = Foursquare2::Client.new(:client_key => 'your_key', :client_secret => 'your_secret')
+ client = Foursquare2::Client.new(:client_id => 'your_client_id', :client_secret => 'your_secret')
### Instantiate a client (Authenticated User Access)
client = Foursquare2::Client.new(:oauth_token => 'user_oauth_token')
@@ -39,12 +39,55 @@
#### Check-in to a venue as the authenticated user
client.checkin(:venueId => "4b2afcaaf964a5205bb324e3", :broadcast => 'public', :ll => '36.142064,-86.816086', :shout => 'zomg coffee!1!')
+## Full list of methods
+
+See [the documentation](http://rubydoc.info/gems/foursquare2/frames) or [foursquare's endpoint list](http://developer.foursquare.com/docs/index_docs.html) for parameters.
+
+ client.checkin
+ client.recent_checkins
+ client.add_checkin
+ client.add_checkin_comment
+ client.delete_checkin_comment
+ client.photo
+ client.settings
+ client.setting
+ client.update_setting
+ client.special
+ client.search_specials
+ client.tip
+ client.search_tips
+ client.add_tip
+ client.mark_tip_todo
+ client.mark_tip_done
+ client.unmark_tip
+ client.user
+ client.search_users
+ client.user_requests
+ client.user_badges
+ client.user_checkins
+ client.user_friends
+ client.user_tips
+ client.user_todos
+ client.user_venue_history
+ client.user_friend_request
+ client.user_unfriend
+ client.user_approve_friend
+ client.user_deny_friend
+ client.user_set_friend_pings
+ client.venue
+ client.search_venues
+ client.venue_categories
+ client.add_venue
+ client.mark_venue_todo
+ client.flag_venue
+ client.propose_venue_edit
+
## Todo
-* Add test coverage
+* More test coverage
* Integrate oauth2 authentication flow
## Contributing to foursquare2
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet