Added a more detailed getting started/usage.

Author: dblock

.rubocop_todo.yml

@@ -1,11 +1,20 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-11-24 21:25:04 UTC using RuboCop version 1.68.0.
+# on 2025-02-01 14:38:28 UTC using RuboCop version 1.68.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/strava-ruby-client.rb'
+    - 'bin/strava-activities.rb'
+
 # Offense count: 13
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.

README.md

@@ -97,6 +97,23 @@ Use an access token obtained from [My API Application](https://www.strava.com/se
 client = Strava::Api::Client.new(
   access_token: "12345678987654321"
 )
+
+client.athlete # => Strava::Models::Athlete
+```
+
+Note that the token from the Strava website does not have enough permissions to retrieve your own activities. Use the [strava-oauth-token tool](#strava-oauth-token) to obtain a short lived with more access scopes.
+
+```bash
+export STRAVA_CLIENT_ID=...
+export STRAVA_CLIENT_SECRET=...
+bundle exec ruby bin/strava-oauth-token
+```
+
+Note the `access_token` from the browser window.
+
+```bash
+export STRAVA_ACCESS_TOKEN=...
+bundle exec ruby bin/strava-activities.rb
 ```
 
 ### Activities

bin/strava-activities.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'strava-ruby-client'
+
+access_token = ENV['STRAVA_ACCESS_TOKEN'] || raise("Missing ENV['STRAVA_ACCESS_TOKEN'].")
+
+client = Strava::Api::Client.new(
+  access_token: access_token
+)
+
+client.athlete_activities.each do |activity|
+  puts activity.name
+end