Update README.md
This commit is contained in:
14
README.md
14
README.md
@@ -23,7 +23,7 @@ Option 1: Install via `pipx` (Recommended)
|
||||
|
||||
2. Install `mdq`:
|
||||
```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
|
||||
@@ -66,18 +66,18 @@ Once installed, you can use the `mdq` command to search through markdown files.
|
||||
Basic Search
|
||||
|
||||
```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
|
||||
|
||||
```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
|
||||
|
||||
@@ -89,7 +89,7 @@ Flags
|
||||
|
||||
Example:
|
||||
```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.
|
||||
@@ -120,7 +120,7 @@ If you have a Markdown file like this:
|
||||
Running the following command:
|
||||
|
||||
```bash
|
||||
mdq "production" /path/to/your/file.md
|
||||
cat /path/to/your/markdown/file.md | mdq production
|
||||
```
|
||||
|
||||
Will output something like:
|
||||
|
||||
Reference in New Issue
Block a user