diff --git a/README.md b/README.md index 673a114..3da0934 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # repo-to-text -`repo-to-text` is an open-source project that converts the structure and contents of a directory (repository) into a single text file. By executing a simple command in the terminal, this tool generates a text representation of the directory, including the output of the `tree` command and the contents of each file, formatted for easy reading and sharing. +`repo-to-text` is an open-source project that converts the structure and contents of a directory (repository) into a single text file. By executing a simple command in the terminal, this tool generates a text representation of the directory, including the output of the `tree` command and the contents of each file, formatted for easy reading and sharing. This can be very useful for development and debugging with LLM. ## Example Output The generated text file will include the directory structure and contents of each file. For a full example, see the [example output for this repository](https://github.com/kirill-markin/repo-to-text/blob/main/examples/example_repo_snapshot_2024-06-08-11-35-28-UTC.txt). +The same text will appear in your clipboard. You can paste it into a dialog with the LLM and start communicating. + ## Features - Generates a text representation of a directory's structure.