docs: refresh README for current install, pet, and env var behavior - #56
Open
ishaanxgupta wants to merge 5 commits into
Open
docs: refresh README for current install, pet, and env var behavior#56ishaanxgupta wants to merge 5 commits into
ishaanxgupta wants to merge 5 commits into
Conversation
Several sections had drifted from the current implementation: - The TUI badge is state-aware (accent color follows Codex's live agent state), not static — added by the pet-state-awareness work. - The legacy container-read list was missing cursor_user_*/cursor_project_*, which codex-supermemory has read since the shared-container work. - SUPERMEMORY_MCP_URL, SUPERMEMORY_AUTH_URL, SUPERMEMORY_AUTH_TIMEOUT, SUPERMEMORY_REPO_TAG, and SUPERMEMORY_BASE_URL are all read by the source but were absent from the env var table. - uninstall clears the saved credential file (same directory as the hook scripts it removes), so reinstalling requires signing in again even though server-side memories are untouched. - No mention of the npm update-notice check added at SessionStart. Verified each change against current source (src/config.ts, src/services/ tags.ts, src/services/auth.ts, src/cli.ts, build.mjs pet generator). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Same content, new presentation: - Centered lockup using the product's own mark (◪ — the glyph the hooks already print in notices) instead of a generic logo, tagline, and a three-badge row. - npm version and license badges pull live from the npm registry via shields.io instead of a hardcoded version string, so they can't drift out of sync the way the README text did. - Anchor nav strip under the tagline for quick jumps. - Features rendered as a two-column grid (a table with blank headers, <br>-separated title/description per cell) instead of a flat bullet list. - Hook table reordered into actual lifecycle order (SessionStart -> UserPromptSubmit -> PreToolUse -> Stop) with a Step column and an arrow chain above it, replacing the previous arbitrary ordering. - Agent-state legend (Running/Ready/Blocked/Needs input) as colored-circle emoji standing in for the pet badge's real accent colors from build.mjs. - The long supermemory.json key table moved into a native <details> block so the page stays scannable. - Centered <sub> footer restating the mark's meaning. Verified end-to-end against GitHub's own markdown API (POST /markdown) to confirm every HTML construct used here (div align, details/summary, sub, table + br, image badges) actually renders as intended rather than getting stripped by GitHub's sanitizer. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Corrected the project name in the README and improved clarity in the description.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README-only, no source changes.