@beepbox.net/gofetch-client 0.1.1 → 0.2.1

package/README.md

@@ -19,6 +19,36 @@ const api = createClient()
 // defaults to https://gofetch.blaqat.net
 ```
 
+## Friendly fetcher
+
+Prefer short, namespaced methods over the full treaty path? Use `createFetcher`:
+
+```ts
+import { createFetcher } from '@beepbox.net/gofetch-client'
+
+const client = createFetcher()
+
+const { data } = await client.util.resolveShortUrl('https://tinyurl.com/buwnpvpd')
+console.log(data?.modName)
+```
+
+It wraps the same treaty client — every method maps directly to a route and keeps
+the generated request/response types:
+
+```ts
+await client.beep.list({ songType: 'Original', limit: 20 })
+await client.beep.get(id)
+await client.event.removeHost(eventId, userId)
+await client.user.me({ headers: { Authorization: `Bearer ${token}` } })
+```
+
+Methods are grouped by namespace: `beep`, `event`, `platform`, `source`, `forum`,
+`submission`, `weightGroup`, `xp`, `user`, `util`. Every method takes an optional
+trailing `opts` (`{ headers }`) for per-request auth. The raw treaty client is
+always reachable via `client.raw` as an escape hatch.
+
+`createFetcher` accepts the same options as `createClient` (`baseUrl`, `token`).
+
 ## Auth
 
 Pass a JWT from Discord OAuth (`/v0/auth/discord` → callback):