[add] Example usage

This commit is contained in:
Jose Pablo Domingo Aramburo Sanchez 2024-08-09 16:17:00 -07:00
parent 4698b76a5e
commit 012db9f942

View File

@ -10,3 +10,19 @@ Or download the repo and install from there
git clone https://git.laziness.rocks/PootisPenserHere/code_to_prompt git clone https://git.laziness.rocks/PootisPenserHere/code_to_prompt
pip3 install code_to_prompt pip3 install code_to_prompt
``` ```
## Usage
### Required Arguments
- `--path PATH` or `-p PATH`: Specifies the directory path to process. This can be a relative path (e.g., `.` for the current directory) or an absolute path (e.g., `/home/user/project_1`).
### Optional Arguments
- `--ignore IGNORE` or `-i IGNORE`: Specifies files or directories to ignore. This option can be used multiple times to ignore several elements.
## Examples
```bash
code_to_prompt --path ~/Documents/hello-world --ignore README.md
```