From 214ea0dbb0ca1f5029a8590a01fc0df38d49dafc Mon Sep 17 00:00:00 2001 From: Colby McHenry Date: Tue, 20 Jan 2026 03:21:15 -0600 Subject: [PATCH] Update README to clarify installer auto-configures CLAUDE.md - Add note that installer updates ~/.claude/CLAUDE.md in Quick Start - Rename "Recommended: Add Global Instructions" to "Global Instructions Reference" - Clarify that instructions are added automatically, shown for reference - Bump version to 0.2.7 Co-Authored-By: Claude Opus 4.5 --- README.md | 8 +++++--- package.json | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4068e52..247377a 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,7 @@ npx @colbymchenry/codegraph The interactive installer will: - Configure the MCP server in `~/.claude.json` - Set up auto-allow permissions for CodeGraph tools +- Add global instructions to `~/.claude/CLAUDE.md` (teaches Claude how to use CodeGraph) - Optionally initialize your current project ### 2. Restart Claude Code @@ -220,9 +221,9 @@ npm install -g @colbymchenry/codegraph
-Recommended: Add Global Instructions +Global Instructions Reference -For best results, add to `~/.claude/CLAUDE.md`: +The installer automatically adds these instructions to `~/.claude/CLAUDE.md`. This is provided here for reference: ```markdown ## CodeGraph @@ -299,7 +300,8 @@ The installer will: 1. Ask for installation location (global `~/.claude` or local `./.claude`) 2. Configure the MCP server in `claude.json` 3. Optionally set up auto-allow permissions -4. For local installs: initialize and index the current project +4. Add global instructions to `~/.claude/CLAUDE.md` (teaches Claude how to use CodeGraph) +5. For local installs: initialize and index the current project ### `codegraph init [path]` diff --git a/package.json b/package.json index 5d10d3d..76fe74b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@colbymchenry/codegraph", - "version": "0.2.6", + "version": "0.2.7", "description": "A local-first code intelligence system that builds a semantic knowledge graph from any codebase", "main": "dist/index.js", "types": "dist/index.d.ts",