doc: update README with configuration example
This commit is contained in:
parent
fdc80bfadc
commit
fdab42f2b1
1 changed files with 28 additions and 0 deletions
28
README.md
28
README.md
|
@ -76,6 +76,34 @@ result file itself:
|
|||
| xclip -selection clipboard -i
|
||||
```
|
||||
|
||||
#### Advanced with configuration file
|
||||
|
||||
You can also do the same by storing all parameters within a configuration file
|
||||
(ex: `code_preloader.yml`).
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
ignore_list:
|
||||
- .git
|
||||
- .code_preloader.yml
|
||||
- bin
|
||||
- prompts
|
||||
|
||||
output_file_path: result.txt
|
||||
|
||||
header_prompt_file_path: prompts/header-context.txt
|
||||
|
||||
footer_prompt_file_path: prompts/footer-write-readme.txt
|
||||
```
|
||||
|
||||
Then type
|
||||
|
||||
```bash
|
||||
./bin/code-preloader src | xclip -selection clipboard -i
|
||||
```
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are what make the open-source community such an amazing place to
|
||||
|
|
Loading…
Reference in a new issue