Skip to content

docs: revamp README with centered header and documented missing config/commands - #84

Open
ishaanxgupta wants to merge 1 commit into
mainfrom
docs/readme-refresh
Open

docs: revamp README with centered header and documented missing config/commands#84
ishaanxgupta wants to merge 1 commit into
mainfrom
docs/readme-refresh

Conversation

@ishaanxgupta

@ishaanxgupta ishaanxgupta commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

No description provided.

…g/commands

- Centered header with a dynamic npm version badge (matches the published
  package here, unlike cursor-supermemory) and license badge.
- Two-column feature grid; verified Reasoned Recall against
  services/recall.ts and confirmed it's accurate here (the directive fires
  unconditionally every turn - this plugin has no direct-search hook path
  at all, unlike the codex/claude siblings where a similar-sounding claim
  turned out to be wrong).
- Added an Environment variables table - there wasn't one at all, despite
  SUPERMEMORY_API_URL, SUPERMEMORY_AUTH_URL, SUPERMEMORY_AUTH_TIMEOUT,
  SUPERMEMORY_ISOLATE_WORKTREES, SUPERMEMORY_REPO_TAG all being read in
  source.
- Documented autoRecallEveryPrompt in the config example and Features -
  a real config key (config.ts) controlling whether the first-message
  context injection also runs a semantic search over personal memories,
  previously absent from the README entirely.
- Added cursor_user_*/cursor_project_* to the legacy container list
  (tags.ts reads them; the README didn't mention them) - the same gap
  found and fixed in the codex-supermemory README.
- Documented that /supermemory-init, /supermemory-login,
  /supermemory-logout, and /supermemory-status all exist as in-chat
  commands, not just CLI subcommands.
- Documented the update-notice check (services/version-check.js) and the
  install --disable-context-recovery flag as an alternative to manually
  editing oh-my-opencode.json.
- Tucked the LLM-agent install walkthrough and dev instructions into
  details blocks, kept from the original.
- No em dashes.
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