xle/mdq
1
0
Fork 0
Code Issues Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
Charlie Crossley
2025-08-19 14:50:22 +01:00
parent 3f73f1448b
commit 38b7a94f22
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -23,7 +23,7 @@ Option 1: Install via `pipx` (Recommended)
2. Install `mdq`: 2. Install `mdq`:
```bash ```bash
pipx install git+https://github.com/yourusername/mdq.git pipx install git+https://git.xle.sh/xle/mdq.git
``` ```
Option 2: Install in a Virtual Environment Option 2: Install in a Virtual Environment
@@ -66,18 +66,18 @@ Once installed, you can use the `mdq` command to search through markdown files.
Basic Search Basic Search
```bash ```bash
mdq "search term" /path/to/your/markdown/files/*.md cat /path/to/your/markdown/files/*.md | mdq search_term
``` ```
This will search for the term `"search term"` in all `.md` files in the specified directory. This will search for the term `"search_term"` in all `.md` files in the specified directory.
Multiple Search Terms Multiple Search Terms
```bash ```bash
mdq "term1" "term2" /path/to/your/markdown/files/*.md cat /path/to/your/markdown/files/*.md | mdq search_term_1 search_term_2
``` ```
This will search for both `"term1"` and `"term2"` in the specified markdown files and show the results for both. This will search for both `"search_term_1"` and `"search_term_2"` in the specified markdown files and show the results for both.
Search with Context Search with Context
@@ -89,7 +89,7 @@ Flags
Example: Example:
```bash ```bash
mdq --raw "search term" /path/to/your/markdown/files/*.md cat /path/to/your/markdown/files/*.md | mdq --raw search_term
``` ```
- `--help`: Display help message with available options. - `--help`: Display help message with available options.
@@ -120,7 +120,7 @@ If you have a Markdown file like this:
Running the following command: Running the following command:
```bash ```bash
mdq "production" /path/to/your/file.md cat /path/to/your/markdown/file.md | mdq production
``` ```
Will output something like: Will output something like: