@repome/sdk 0.1.8 → 0.3.0

package/README.md

@@ -8,8 +8,8 @@ runtime with no clone required.
 ```ts
 import { repome } from '@repome/sdk'
 
-const git = await repome('acme/my-repo', {
-  token: process.env.REPOME_TOKEN!,
+const git = await repome('my-repo', {
+  token: process.env.REPOME_API_KEY!,
 })
 
 await git.add('src/main.ts', sourceCode)
@@ -17,14 +17,26 @@ await git.add('README.md', readmeText)
 
 const commit = await git.commit('feat: generated output')
 console.log(commit.sha) // a1b2c3d4...
-console.log(commit.url) // https://api.repome.sh/acme/my-repo/commit/a1b2c3d
+console.log(commit.url) // https://api.repome.sh/my-repo/commit/a1b2c3d
 ```
 
-`repome(slug, options)` returns a `GitRepo` bound to one repo. The repo is
-created automatically if it does not exist. Files staged with `add()` are
-held in memory and pushed as a single atomic commit when you call
+`repome(name, options)` returns a `GitRepo` bound to one repo, addressed by
+bare name and scoped to the API key's active org — there is no `org/` prefix.
+The repo is created automatically if it does not exist. Files staged with
+`add()` are held in memory and pushed as a single atomic commit when you call
 `commit()`.
 
+`token` must be an `rpme_` API key — create one with
+`repome keys create <name> --scope repos:write` or the `keys.create` API.
+Repo-scoped `art_v1_*` tokens (the output of `tokens.mint` /
+`repome tokens mint`) are **not** accepted by the SDK; they are git
+credentials only, used as the Basic-auth password when cloning or pushing
+the repo's remote with plain git:
+
+```bash
+git clone https://x-access-token:<art_v1_token>@<repo-remote>
+```
+
 ```ts
 interface GitRepo {
   add(path: string, content: string | Uint8Array): Promise<void>
@@ -70,7 +82,7 @@ const client = createClient({
   apiKey: process.env.REPOME_API_KEY!,
 })
 
-const { items } = await client.repos.list({ orgSlug: 'acme' })
+const { items } = await client.repos.list({})
 ```
 
 API keys must use the `rpme_` prefix and are sent as
@@ -99,5 +111,5 @@ REPOME_SMOKE_NAME=sdk-smoke vp run @repome/sdk#smoke
 
 Inputs: `REPOME_API_KEY` (required; needs `repos:read` + `repos:write`),
 `REPOME_SERVER_URL` (default `https://api.repome.sh`),
-`REPOME_SMOKE_ORG` (default: active org from `me.get`),
-`REPOME_SMOKE_NAME`, `REPOME_SMOKE_KEEP=1`.
+`REPOME_SMOKE_NAME`, `REPOME_SMOKE_KEEP=1`. The repo is created in the API
+key's active org.