Skip to content

Commit b2c1618

Browse files
committed
docs: add badges, features section, and contributing link to README
- Add CI, crates.io version, and license badges - Add Features section summarizing key capabilities - Add Contributing section linking to CONTRIBUTING.md - Add reviews/ to .gitignore
1 parent e751324 commit b2c1618

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ zig/zig-out/
99
zig/.zig-cache/
1010
.xgrep/
1111
docs/superpowers/
12+
reviews/
1213
bench/results/
1314
bench/ripgrep-src/
1415
bench/.zoekt-idx-*/

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# xgrep
22

3+
[![CI](https://github.com/momokun7/xgrep/actions/workflows/ci.yml/badge.svg)](https://github.com/momokun7/xgrep/actions/workflows/ci.yml)
4+
[![Crates.io](https://img.shields.io/crates/v/xgrep-search.svg)](https://crates.io/crates/xgrep-search)
5+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
6+
37
Ultra-fast indexed code search engine with MCP server for AI coding tools.
48

59
Pre-builds a trigram inverted index, then searches in milliseconds. Designed for repeated searches on large codebases — by humans and AI agents alike.
610

11+
## Features
12+
13+
- **Indexed search** — trigram inverted index makes repeated searches 2-59x faster than ripgrep
14+
- **File discovery**`--find` mode locates files 4-36x faster than fd/find
15+
- **MCP server** — built-in [Model Context Protocol](https://modelcontextprotocol.io/) server for AI coding tools (Claude Code, Cursor, etc.)
16+
- **LLM-optimized output**`--format llm` produces Markdown with language tags, context lines, and token-aware truncation
17+
- **Git-aware** — search only changed files (`--changed`), recent commits (`--since 1h`), respects `.gitignore`
18+
- **Zero config**`cargo install xgrep-search`, then `xg "pattern"`. Index builds automatically on first search
19+
- **Hybrid search** — serves results from index instantly while rebuilding in the background
20+
721
## Why xgrep?
822

923
| | ripgrep | zoekt | xgrep |
@@ -258,6 +272,10 @@ Follows the same convention as ripgrep.
258272
3. **Hybrid Mode**: When the index is stale, combines index results with direct scanning of changed files — no rebuild needed
259273
4. **MCP Server**: Exposes search via JSON-RPC over stdio, with LLM-optimized output and token-aware truncation
260274

275+
## Contributing
276+
277+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
278+
261279
## License
262280

263281
MIT

0 commit comments

Comments
 (0)