Skip to content

Commit fa3c049

Browse files
committed
Refactor README to improve Table of Contents structure and update event model reference from 'object_id' to 'id'
1 parent 1e8e1ae commit fa3c049

File tree

1 file changed

+72
-70
lines changed

1 file changed

+72
-70
lines changed

README.md

Lines changed: 72 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -9,75 +9,77 @@ Unlike other clients, including [strava-api-v3](https://github.com/jaredholdcrof
99

1010
## Table of Contents
1111

12-
- [Installation](#installation)
13-
- [Usage](#usage)
14-
- [Activities](#activities)
15-
- [Create an Activity](#create-an-activity)
16-
- [Get Activity](#get-activity)
17-
- [List Activity Photos](#list-activity-photos)
18-
- [List Activity Comments](#list-activity-comments)
19-
- [List Activity Kudoers](#list-activity-kudoers)
20-
- [List Activity Laps](#list-activity-laps)
21-
- [List Athlete Activities](#list-athlete-activities)
22-
- [Get Activity Zones](#get-activity-zones)
23-
- [Update Activity](#update-activity)
24-
- [Athletes](#athletes)
25-
- [Get Authenticated Athlete](#get-authenticated-athlete)
26-
- [Get Zones](#get-zones)
27-
- [Get Athlete Stats](#get-athlete-stats)
28-
- [Update Athlete](#update-athlete)
29-
- [Clubs](#clubs)
30-
- [List Club Activities](#list-club-activities)
31-
- [List Club Events](#list-club-events)
32-
- [List Club Administrators](#list-club-administrators)
33-
- [Get Club](#get-club)
34-
- [List Club Members](#list-club-members)
35-
- [List Athlete Clubs](#list-athlete-clubs)
36-
- [Gears](#gears)
37-
- [Get Equipment](#get-equipment)
38-
- [Routes](#routes)
39-
- [Export Route GPX](#export-route-gpx)
40-
- [Export Route TCX](#export-route-tcx)
41-
- [Get Route](#get-route)
42-
- [List Athlete Routes](#list-athlete-routes)
43-
- [Running Races](#running-races)
44-
- [Get Running Race](#get-running-race)
45-
- [Segment Efforts](#segment-efforts)
46-
- [List Segment Efforts](#list-segment-efforts)
47-
- [Get Segment Effort](#get-segment-effort)
48-
- [Segments](#segments)
49-
- [Explore Segments](#explore-segments)
50-
- [List Starred Segments](#list-starred-segments)
51-
- [Get Segment](#get-segment)
52-
- [Star Segment](#star-segment)
53-
- [Streams](#streams)
54-
- [Get Activity Streams](#get-activity-streams)
55-
- [Get Segment Effort Streams](#get-segment-effort-streams)
56-
- [Get Segment Streams](#get-segment-streams)
57-
- [Uploads](#uploads)
58-
- [Upload Activity](#upload-activity)
59-
- [Get Upload](#get-upload)
60-
- [Pagination](#pagination)
61-
- [OAuth](#oauth)
62-
- [OAuth Workflow](#oauth-workflow)
63-
- [Deauthorize](#deauthorize)
64-
- [Command Line OAuth Workflow](#command-line-oauth-workflow)
65-
- [Webhooks](#webhooks)
66-
- [Ratelimit](#ratelimit)
67-
- [Exceeded Ratelimit](#exceeded-ratelimit)
68-
- [Configuration](#configuration)
69-
- [Web Client Options](#web-client-options)
70-
- [API Client Options](#api-client-options)
71-
- [OAuth Client Options](#oauth-client-options)
72-
- [Webhooks Client Options](#webhooks-client-options)
73-
- [Errors](#errors)
74-
- [Tools](#tools)
75-
- [Strava OAuth Token](#strava-oauth-token)
76-
- [Users](#users)
77-
- [Resources](#resources)
78-
- [Upgrading](#upgrading)
79-
- [Contributing](#contributing)
80-
- [Copyright and License](#copyright-and-license)
12+
- [Strava Ruby Client](#strava-ruby-client)
13+
- [Table of Contents](#table-of-contents)
14+
- [Installation](#installation)
15+
- [Usage](#usage)
16+
- [Activities](#activities)
17+
- [Create an Activity](#create-an-activity)
18+
- [Get Activity](#get-activity)
19+
- [List Activity Photos](#list-activity-photos)
20+
- [List Activity Comments](#list-activity-comments)
21+
- [List Activity Kudoers](#list-activity-kudoers)
22+
- [List Activity Laps](#list-activity-laps)
23+
- [List Athlete Activities](#list-athlete-activities)
24+
- [Get Activity Zones](#get-activity-zones)
25+
- [Update Activity](#update-activity)
26+
- [Athletes](#athletes)
27+
- [Get Authenticated Athlete](#get-authenticated-athlete)
28+
- [Get Zones](#get-zones)
29+
- [Get Athlete Stats](#get-athlete-stats)
30+
- [Update Athlete](#update-athlete)
31+
- [Clubs](#clubs)
32+
- [List Club Activities](#list-club-activities)
33+
- [List Club Events](#list-club-events)
34+
- [List Club Administrators](#list-club-administrators)
35+
- [Get Club](#get-club)
36+
- [List Club Members](#list-club-members)
37+
- [List Athlete Clubs](#list-athlete-clubs)
38+
- [Gears](#gears)
39+
- [Get Equipment](#get-equipment)
40+
- [Routes](#routes)
41+
- [Export Route GPX](#export-route-gpx)
42+
- [Export Route TCX](#export-route-tcx)
43+
- [Get Route](#get-route)
44+
- [List Athlete Routes](#list-athlete-routes)
45+
- [Running Races](#running-races)
46+
- [Get Running Race](#get-running-race)
47+
- [Segment Efforts](#segment-efforts)
48+
- [List Segment Efforts](#list-segment-efforts)
49+
- [Get Segment Effort](#get-segment-effort)
50+
- [Segments](#segments)
51+
- [Explore Segments](#explore-segments)
52+
- [List Starred Segments](#list-starred-segments)
53+
- [Get Segment](#get-segment)
54+
- [Star Segment](#star-segment)
55+
- [Streams](#streams)
56+
- [Get Activity Streams](#get-activity-streams)
57+
- [Get Segment Effort Streams](#get-segment-effort-streams)
58+
- [Get Segment Streams](#get-segment-streams)
59+
- [Uploads](#uploads)
60+
- [Upload Activity](#upload-activity)
61+
- [Get Upload](#get-upload)
62+
- [Pagination](#pagination)
63+
- [OAuth](#oauth)
64+
- [OAuth Workflow](#oauth-workflow)
65+
- [Deauthorize](#deauthorize)
66+
- [Command Line OAuth Workflow](#command-line-oauth-workflow)
67+
- [Webhooks](#webhooks)
68+
- [Ratelimit](#ratelimit)
69+
- [Exceeded Ratelimit](#exceeded-ratelimit)
70+
- [Configuration](#configuration)
71+
- [Web Client Options](#web-client-options)
72+
- [API Client Options](#api-client-options)
73+
- [OAuth Client Options](#oauth-client-options)
74+
- [Webhooks Client Options](#webhooks-client-options)
75+
- [Errors](#errors)
76+
- [Tools](#tools)
77+
- [Strava OAuth Token](#strava-oauth-token)
78+
- [Users](#users)
79+
- [Resources](#resources)
80+
- [Upgrading](#upgrading)
81+
- [Contributing](#contributing)
82+
- [Copyright and License](#copyright-and-license)
8183

8284
## Installation
8385

@@ -895,7 +897,7 @@ event = Strava::Webhooks::Models::Event.new(JSON.parse(request.body))
895897

896898
event # => Strava::Webhooks::Models::Event
897899
event.object_type # => 'activity'
898-
event.object_id # => 1991813808
900+
event.id # => 1991813808
899901
event.aspect_type # => 'update'
900902
event.updates # => { 'sport_type' => 'Walk' }
901903
event.owner_id # => 29323238

0 commit comments

Comments
 (0)