Skip to content

chore: update the README#106

Open
joeldierkes wants to merge 1 commit intomainfrom
chore/update-readme
Open

chore: update the README#106
joeldierkes wants to merge 1 commit intomainfrom
chore/update-readme

Conversation

@joeldierkes
Copy link
Contributor

@joeldierkes joeldierkes commented Dec 22, 2025

Note

Rewrites and expands the README with a clearer structure, new command reference and web search docs, benchmarks, updated configuration (including new env var defaults), and a how-it-works overview.

  • Docs (README):
    • Restructure: Reorders content into Quick Start → Why mgrep → When to use what → Benchmarks.
    • Command Reference: Adds detailed mgrep search and mgrep watch options with examples; introduces a Web Search subsection under commands.
    • Configuration: Consolidates config file, environment variables, and tips; updates defaults for MGREP_MAX_FILE_SIZE (1MB) and MGREP_MAX_FILE_COUNT (1000); fixes links to point to Configuration.
    • How It Works: Adds internal overview of stores, reranking, and results metadata.
    • Agents & Extras: Clarifies agent install commands; adds Testing, Troubleshooting, Support; minor copy/format cleanups.

Written by Cursor Bugbot for commit ad6e812. This will update automatically on new commits. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant