From fdab42f2b14141c264248059960e120c543edbb7 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 29 Dec 2023 16:35:13 +0100 Subject: [PATCH] doc: update README with configuration example --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index f2c0463..2c71ea1 100644 --- a/README.md +++ b/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