Skip to content

Commit a2105ea

Browse files
committed
Enhance README with visual examples and add new assets
- Updated README.md to include a section showcasing CLI output with images demonstrating patterns, edit preflight, symbol references, and codebase overview. - Added new image assets: metadata.png, patterns.png, refs-symbol.png, search-query.png, and search-query-low-quality-evidence.png to support the README enhancements.
1 parent 92a6a8f commit a2105ea

6 files changed

Lines changed: 26 additions & 2 deletions

File tree

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,32 @@ One tool call returns all of it. Local-first - your code never leaves your machi
2222

2323
The index auto-refreshes as you edit - a file watcher triggers incremental reindex in the background when the MCP server is running. No stale context between tool calls.
2424

25-
<!-- TODO: Add demo GIF: search_codebase("How does this app attach the auth token to outgoing API calls?") -> AuthInterceptor top result + preflight + agent proceeds or asks -->
26-
<!-- ![Demo](./docs/assets/demo.gif) -->
25+
### What it looks like
26+
27+
Real CLI output against `angular-spotify`, the repo used for the launch screenshots.
28+
29+
<table>
30+
<tr>
31+
<td width="50%">
32+
<strong>Patterns and team drift</strong><br />
33+
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/patterns.png" alt="codebase-context patterns screenshot" />
34+
</td>
35+
<td width="50%">
36+
<strong>Edit preflight</strong><br />
37+
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/search-query.png" alt="codebase-context search preflight screenshot" />
38+
</td>
39+
</tr>
40+
<tr>
41+
<td width="50%">
42+
<strong>Symbol references</strong><br />
43+
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/refs-symbol.png" alt="codebase-context symbol references screenshot" />
44+
</td>
45+
<td width="50%">
46+
<strong>Codebase overview</strong><br />
47+
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/metadata.png" alt="codebase-context metadata screenshot" />
48+
</td>
49+
</tr>
50+
</table>
2751

2852
## Quick Start
2953

docs/assets/metadata.png

19.1 KB
Loading

docs/assets/patterns.png

41.4 KB
Loading

docs/assets/refs-symbol.png

54.6 KB
Loading
66.8 KB
Loading

docs/assets/search-query.png

500 KB
Loading

0 commit comments

Comments
 (0)