Skip to content

Commit abcaa72

Browse files
committed
Revise README for clearer method descriptions and requirements; update UPGRADE.md for consistent emoji usage
1 parent a2062b1 commit abcaa72

2 files changed

Lines changed: 8 additions & 27 deletions

File tree

README.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -161,31 +161,12 @@ Get credentials at [Discogs Developer Settings](https://www.discogs.com/settings
161161

162162
### Quick Reference
163163

164-
| Level | Method | Credentials Needed | Access |
165-
|-------|-----------------------------------|--------------------|-----------------------------------------|
166-
| 1️⃣ | `create()` | None | Public data (artists, releases, labels) |
167-
| 2️⃣ | `createWithConsumerCredentials()` | App key + secret | + Database search |
168-
| 3️⃣ | `createWithPersonalAccessToken()` | + Personal token | + Your collections/wantlist |
169-
| 4️⃣ | `createWithOAuth()` | + OAuth tokens | + Act for other users |
170-
171-
### Implementation
172-
173-
```php
174-
// Level 1: Public data only
175-
$discogs = DiscogsClientFactory::create();
176-
177-
// Level 2: Search enabled
178-
$discogs = DiscogsClientFactory::createWithConsumerCredentials('key', 'secret');
179-
$results = $discogs->search('Taylor Swift');
180-
181-
// Level 3: Your account access (most common)
182-
$discogs = DiscogsClientFactory::createWithPersonalAccessToken('token');
183-
$folders = $discogs->listCollectionFolders('you');
184-
$wantlist = $discogs->getUserWantlist('you');
185-
186-
// Level 4: Multi-user apps
187-
$discogs = DiscogsClientFactory::createWithOAuth('key', 'secret', 'oauth_token', 'oauth_secret');
188-
```
164+
| What you want to do | Method | What you need |
165+
|-------------------------|-----------------------------------|------------------|
166+
| Get artist/release info | `create()` | Nothing |
167+
| Search the database | `createWithConsumerCredentials()` | Register app |
168+
| Access your collection | `createWithPersonalAccessToken()` | Personal token |
169+
| Multi-user app | `createWithOAuth()` | Full OAuth setup |
189170

190171
### Complete OAuth Flow Example
191172

UPGRADE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $search = $discogs->search('Billie Eilish', 'artist');
3636
- **Developer Experience**: ~750 lines of focused code with comprehensive type safety
3737
- **Type Safety**: Automatic parameter validation and conversion
3838

39-
## 📋 Migration Steps
39+
## Migration Steps
4040

4141
### Step 1: Update Dependencies
4242

@@ -89,7 +89,7 @@ Parameters follow the order defined in the [service configuration](resources/ser
8989

9090
**💡 Tip**: Use `null` for optional parameters you want to skip.
9191

92-
## 📋 Migration Examples
92+
## � Migration Examples
9393

9494
### Database Methods
9595

0 commit comments

Comments
 (0)