From 61a7fb4188fdef42217099257d9ac67c29cab496 Mon Sep 17 00:00:00 2001 From: Kirill Markin Date: Sat, 8 Jun 2024 14:13:32 +0200 Subject: [PATCH] cleanup --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e7748bf..673a114 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ `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. +## 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). + ## Features - Generates a text representation of a directory's structure. @@ -48,10 +52,6 @@ You can customize the behavior of `repo-to-text` with the following options: repo-to-text --debug ``` -## 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). - ## Install Locally To install `repo-to-text` locally for development, follow these steps: