1
0
Эх сурвалжийг харах

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 <noreply@anthropic.com>
Colby McHenry 5 сар өмнө
parent
commit
214ea0dbb0
2 өөрчлөгдсөн 6 нэмэгдсэн , 4 устгасан
  1. 5 3
      README.md
  2. 1 1
      package.json

+ 5 - 3
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
 </details>
 
 <details>
-<summary><strong>Recommended: Add Global Instructions</strong></summary>
+<summary><strong>Global Instructions Reference</strong></summary>
 
-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]`
 

+ 1 - 1
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",