forked from ericgoodwin/strava-api-v3
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathparams.json
1 lines (1 loc) · 1.39 KB
/
params.json
1
{"name":"strava-api-v3","tagline":"This gem provides a wrapper around the Strava API V3","body":"# strava-api-v3\r\n\r\n[![Build Status](https://secure.travis-ci.org/jaredholdcroft/strava-api-v3.png)](http://travis-ci.org/jaredholdcroft/strava-api-v3) [![Code Climate](https://codeclimate.com/github/jaredholdcroft/strava-api-v3.png)](https://codeclimate.com/github/jaredholdcroft/strava-api-v3)\r\n\r\nThis gem provides a wrapper around the Strava API V3 - [http://strava.github.io/api/](http://strava.github.io/api/)\r\n\r\n## Install\r\n\r\ngem install 'strava-api-v3'\r\n\r\n## Create a client\r\n\r\nAt this point you will need to have the user authorise your application using OAuth2. \r\n\r\n```ruby\r\n\r\n@client = Strava::Api::V3::Client.new(:access_token => \"MY_ACCESS_TOKEN\")\r\n```\r\n\r\n## Call API methods\r\n\r\n### Athlete\r\n\r\nEach method returns a JSON object - see [http://strava.github.io/api/v3/athlete/](http://strava.github.io/api/v3/athlete/) for more info\r\n\r\n```ruby\r\n\r\[email protected]_current_athlete # fetch the authenticated athlete\r\n\r\[email protected]_another_athlete(:some_id) # fetch another athlete by id\r\n\r\[email protected]_athlete_segment_efforts(:some_id) # fetch K/QOMs/CRs for another athlete by id\r\n\r\n```\r\n\r\n\r\n## Contributors\r\n\r\n* Jared Holdcroft\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}