Skip to content

docs: rewrite README to the Corbits README standard - #15

Merged
TheGreatAxios merged 1 commit into
cl-9405-codex-provider-add-an-opt-in-live-codex-testfrom
cl-9406-codex-provider-rewrite-the-readme-to-the-corbits-readme
Sep 27, 2026
Merged

TheGreatAxios merged 1 commit into
cl-9405-codex-provider-add-an-opt-in-live-codex-testfrom
cl-9406-codex-provider-rewrite-the-readme-to-the-corbits-readme

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Closes CL-9406

Summary

Rewrites the README to the Corbits README standard:

  • Opener naming what the package is and where it plugs into @intx/inference, then "Why @corbits/codex-provider?" with three points.
  • One bun add line with the peers, in place of the npm/pnpm/yarn/bun list.
  • Quickstart: one real turn through runInference with createCodexResponsesAdapter and withCodexContentTypeRepair, printing the streamed text. Needs CODEX_ACCESS_TOKEN and CODEX_ACCOUNT_ID, and throws if either is unset. A comment explains why deps is built directly: createDependencies binds the global fetch, so it cannot install the content-type repair.
  • Where it fits → Reference (every export) → Using with Interchange (the OAuthLoginProviders entry and an AdapterManifest entry with the wrapped fetch) → License.
  • "Runtime support", "How it works" and "Development" are removed; the runtime line moves under Install, and development notes move to CONTRIBUTING later in this stack.

Checks

Every ts block typechecks against src/. bun run check passes.

@TheGreatAxios
TheGreatAxios added this pull request to stack #18 September 26, 2026 04:21
@TheGreatAxios
TheGreatAxios force-pushed the cl-9406-codex-provider-rewrite-the-readme-to-the-corbits-readme branch from c2263e2 to 424935a Compare September 26, 2026 04:26
@TheGreatAxios
TheGreatAxios merged commit 9dadde2 into main Sep 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant