From aa0864d0bd5bc08d65270422c1f763b10eb2b3e6 Mon Sep 17 00:00:00 2001
From: DeusData <martin.vogel.tech@gmail.com>
Date: Sun, 12 Apr 2026 18:29:10 +0100
Subject: [PATCH] Add README and fix files list for npm package

Adds a README.md to pkg/npm so the npmjs.com package page shows
documentation. Updates the files list in package.json to include it.
Will be published with the next version bump.
---
 pkg/npm/README.md    | 90 ++++++++++++++++++++++++++++++++++++++++++++
 pkg/npm/package.json |  3 +-
 2 files changed, 92 insertions(+), 1 deletion(-)
 create mode 100644 pkg/npm/README.md

diff --git a/pkg/npm/README.md b/pkg/npm/README.md
new file mode 100644
index 000000000..afb33ee51
--- /dev/null
+++ b/pkg/npm/README.md
@@ -0,0 +1,90 @@
+# codebase-memory-mcp
+
+[![npm](https://img.shields.io/npm/v/codebase-memory-mcp?style=flat&color=blue)](https://www.npmjs.com/package/codebase-memory-mcp)
+[![GitHub Release](https://img.shields.io/github/v/release/DeusData/codebase-memory-mcp?style=flat&color=blue)](https://github.com/DeusData/codebase-memory-mcp/releases/latest)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/DeusData/codebase-memory-mcp/blob/main/LICENSE)
+[![Platform](https://img.shields.io/badge/macOS_%7C_Linux_%7C_Windows-supported-lightgrey)](https://github.com/DeusData/codebase-memory-mcp/releases/latest)
+
+**The fastest and most efficient code intelligence engine for AI coding agents.** Full-indexes an average repository in milliseconds, the Linux kernel (28M LOC, 75K files) in 3 minutes. Answers structural queries in under 1ms. Ships as a single static binary — this package downloads and runs it automatically.
+
+High-quality parsing through [tree-sitter](https://tree-sitter.github.io/tree-sitter/) AST analysis across 66 languages — producing a persistent knowledge graph of functions, classes, call chains, HTTP routes, and cross-service links. 14 MCP tools. Zero dependencies. Plug and play across 10 coding agents.
+
+## Installation
+
+```bash
+npm install -g codebase-memory-mcp
+```
+
+The binary for your platform is downloaded automatically at install time. Then configure your coding agents:
+
+```bash
+codebase-memory-mcp install
+```
+
+Restart your agent. Say **"Index this project"** — done.
+
+## Why codebase-memory-mcp
+
+- **Extreme indexing speed** — Linux kernel (28M LOC, 75K files) in 3 minutes. RAM-first pipeline with LZ4 compression and in-memory SQLite.
+- **Plug and play** — single static binary for macOS (arm64/amd64), Linux (arm64/amd64), and Windows (amd64). No Docker, no runtime dependencies, no API keys.
+- **66 languages** — vendored tree-sitter grammars compiled into the binary. Nothing to install, nothing that breaks.
+- **120x fewer tokens** — 5 structural queries: ~3,400 tokens vs ~412,000 via file-by-file search.
+- **10 agents, one command** — `install` auto-detects Claude Code, Codex CLI, Gemini CLI, Zed, OpenCode, Antigravity, Aider, KiloCode, VS Code, and OpenClaw.
+- **14 MCP tools** — search, trace, architecture, impact analysis, Cypher queries, dead code detection, cross-service HTTP linking, ADR management, and more.
+
+## Supported Platforms
+
+| OS      | Architecture |
+|---------|-------------|
+| macOS   | arm64, amd64 |
+| Linux   | arm64, amd64 |
+| Windows | amd64 |
+
+## Usage
+
+```bash
+codebase-memory-mcp install          # configure all detected coding agents
+codebase-memory-mcp --version
+codebase-memory-mcp --help
+codebase-memory-mcp update           # update to latest release
+codebase-memory-mcp uninstall        # remove agent configs
+```
+
+### CLI Mode
+
+Every MCP tool is also available directly from the command line:
+
+```bash
+codebase-memory-mcp cli index_repository '{"repo_path": "/path/to/repo"}'
+codebase-memory-mcp cli search_graph '{"name_pattern": ".*Handler.*", "label": "Function"}'
+codebase-memory-mcp cli trace_call_path '{"function_name": "main", "direction": "both"}'
+codebase-memory-mcp cli get_architecture '{}'
+```
+
+## MCP Tools
+
+| Category | Tools |
+|----------|-------|
+| **Indexing** | `index_repository`, `list_projects`, `delete_project`, `index_status` |
+| **Querying** | `search_graph`, `trace_call_path`, `detect_changes`, `query_graph` |
+| **Analysis** | `get_architecture`, `get_graph_schema`, `get_code_snippet`, `search_code` |
+| **Advanced** | `manage_adr`, `ingest_traces` |
+
+## Performance
+
+Benchmarked on Apple M3 Pro:
+
+| Operation | Time |
+|-----------|------|
+| Linux kernel full index (28M LOC, 75K files) | 3 min |
+| Django full index | ~6s |
+| Cypher query | <1ms |
+| Trace call path (depth=5) | <10ms |
+
+## Full Documentation
+
+See [github.com/DeusData/codebase-memory-mcp](https://github.com/DeusData/codebase-memory-mcp) for the full README including all MCP tools, configuration options, graph data model, and language support details.
+
+## License
+
+MIT
diff --git a/pkg/npm/package.json b/pkg/npm/package.json
index 39de59a3c..662f96f32 100644
--- a/pkg/npm/package.json
+++ b/pkg/npm/package.json
@@ -34,6 +34,7 @@
   "cpu": ["x64", "arm64"],
   "files": [
     "bin.js",
-    "install.js"
+    "install.js",
+    "README.md"
   ]
 }