Rewrite README for a proper open-source landing page#125
Merged
Conversation
The old README was stale (referenced a removed Strava()/isInDebug API, a "heavy refactoring" warning, and outdated endpoint names). Replace with an accurate, structured README: - Badges (pub, CI, license), feature overview, table of contents - Quick start using the real StravaClient + repository API - Android/iOS setup, authentication + scopes, token refresh notes - Making calls (repository table + examples), Fault error handling - Collapsible supported-endpoints list matching the current API - Example explorer app instructions, contributing, acknowledgements, license Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The previous README was out of date — it referenced a removed
Strava()/isInDebuginitialization API, carried a "heavy refactoring" warning, and listed endpoint names that no longer match the code.This rewrite is accurate to the current package and structured for an open-source landing page:
StravaClientconstruction +authentication.authenticate+ a repository call.forceShowingApproval/preferEphemeral, and a note on automatic token storage + refresh.Faultexample.Docs only — no code changes.
🤖 Generated with Claude Code