Skip to content

docs: revamp README with centered header and corrected recall/memory docs - #118

Open
ishaanxgupta wants to merge 2 commits into
mainfrom
docs/readme-refresh
Open

docs: revamp README with centered header and corrected recall/memory docs#118
ishaanxgupta wants to merge 2 commits into
mainfrom
docs/readme-refresh

Conversation

@ishaanxgupta

@ishaanxgupta ishaanxgupta commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

No description provided.

…l/memory docs

- Centered header with dynamic version badge (reads plugin.json live) and
  license badge, matching the codex-supermemory README treatment.
- Two-column feature grid, hook-lifecycle table with an arrow chain, a
  collapsible section for the old-plugin migration note.
- Commands table trimmed to /supermemory:status, the only command that still
  exists; index/project-config/logout/session were removed in the CLI-free
  architecture refactor (44610b0) and the README never caught up.
- Recall description corrected: default behavior is the hook searching
  directly on every substantive prompt (recall-directive.js says so
  explicitly in comments), not Claude reasoning about whether to search.
  Reasoned/advisory recall is opt-in via recallDirective.
- Shared Agents memory section corrected: this plugin only ever uses one
  container tag (repo_<name>__<hash>); unlike Codex it does not read legacy
  per-tool containers (verified against container-tag.js and api.js, which
  send a single containerTag, no legacy fallback list).
- Documented previously-undocumented real features: the animated statusline
  installed on first run, and the welcome-back notice after 6+ hours away.
- Added missing env vars (SUPERMEMORY_API_URL, SUPERMEMORY_MCP_URL,
  SUPERMEMORY_AUTH_URL, SUPERMEMORY_REPO_TAG, SUPERMEMORY_ISOLATE_WORKTREES)
  and missing settings keys (debug, injectProfile) that exist in source but
  were absent from the tables.
- 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