Skip to content

Commit b613627

Browse files
committed
Added features of CircuitBreaker, Retry, Logger, and documentation
1 parent b4342de commit b613627

34 files changed

+1521
-440
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,9 @@ First, you must have your API key from Groundspeak, but access to the API are no
3232

3333
You can find an example of implementation (with OAuth 2) in this repository: https://github.com/Surfoo/geocaching-api-demo
3434

35-
## Usage Guide
35+
## Documentation
3636

37-
See [`USAGE.md`](./USAGE.md) for detailed usage instructions, including:
38-
39-
- Basic usage examples
40-
- Complete API method reference
41-
- HTTP logging configuration
37+
Start with [`docs/README.md`](./docs/README.md) for getting started, authentication, configuration, reliability patterns, and domain-by-domain API examples.
4238

4339
## HTTP Request/Response Logging
4440

USAGE.md

Lines changed: 0 additions & 287 deletions
This file was deleted.

docs/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Geocaching PHP SDK Documentation
2+
3+
This folder collects the SDK documentation with examples for the Groundspeak Geocaching API. Each page focuses on a specific topic so you can jump straight to what you need.
4+
5+
## Contents
6+
- [Getting Started](./getting-started.md) — install the package, create an SDK client, and make your first request.
7+
- [Authentication & Tokens](./authentication.md) — work with access tokens, wire OAuth, and enable automatic refresh.
8+
- [Configuration & HTTP Clients](./configuration.md) — understand runtime options, environments, and how to plug in custom PSR clients.
9+
- [Reliability & Observability](./reliability.md) — enable structured logging, retries, and circuit breaking for resilient calls.
10+
- [API Usage by Domain](./api-usage.md) — call the main API areas (geocaches, users, adventures, trackables, lists, status) with documented examples.

0 commit comments

Comments
 (0)