Skip to content

docs: SEO polish — keyword-rich README, current examples, troubleshooting FAQ - #5

Merged
hcsolakoglu merged 1 commit into
mainfrom
docs/seo-readme-polish
Aug 15, 2026
Merged

docs: SEO polish — keyword-rich README, current examples, troubleshooting FAQ#5
hcsolakoglu merged 1 commit into
mainfrom
docs/seo-readme-polish

Conversation

@hcsolakoglu

Copy link
Copy Markdown
Owner

Presentation and discoverability pass, following the contract-lock merge.

README

  • Keyword-rich tagline/intro naming the category (OpenAI Codex rate-limit reset credits); CI + npm-downloads badges added next to the existing npm/license/node badges
  • New "Why not just the Codex TUI?" comparison table — the honest differentiators (multi-account aggregation, non-interactive --json for scripts/CI, batch --all, credit expiry tracking, cross-invocation idempotent retry)
  • Example outputs updated to the current weekly-primary shape — the old examples still showed the retired 5h + weekly dual-window layout; live /wham/usage reports weekly primary with an absent secondary
  • New Troubleshooting FAQ targeting real search phrases: "No Codex accounts found", 401/token-expired, keyring not read, "Secondary limit: unavailable" (why), PAT accounts missing, 429/Retry-After, double-spend safety

package.json — expanded description + npm keywords (openai-codex, codex-cli, chatgpt, rate-limit-reset, usage, quota, terminal, typescript, …). Takes effect on the next npm publish.

Repo metadata (already applied via gh repo edit, no commit needed): description, homepage → npm package, and 19 GitHub topics (codex, openai-codex, codex-cli, chatgpt, rate-limit, credits, cli, developer-tools, …).

No behavioral changes; gate re-run locally: build/typecheck/lint/test → 123/123 green.

…ting FAQ

- tagline and intro name the product category (OpenAI Codex rate-limit reset
  credits) and differentiators up front; add CI + npm downloads badges
- add "Why not just the Codex TUI?" comparison table (multi-account
  aggregation, non-interactive JSON, batch resets, expiry tracking)
- update list/reset examples to the current weekly-primary shape (5h window
  retired by OpenAI; secondary renders unavailable) instead of the stale
  dual-window output
- add Troubleshooting FAQ covering the phrases users actually search
  (no accounts found, 401/token expired, keyring, secondary unavailable,
  PAT missing, 429, double-spend safety)
- package.json: expand description and npm keywords
  (openai-codex, codex-cli, chatgpt, rate-limit-reset, usage, quota, …)

Repo metadata (description, homepage, 19 topics) updated separately via gh.
@hcsolakoglu
hcsolakoglu merged commit b3e7915 into main Aug 15, 2026
6 checks passed
@hcsolakoglu
hcsolakoglu deleted the docs/seo-readme-polish branch August 15, 2026 23:50
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