From f01921e087407522869e8beffcb02a645af6ed23 Mon Sep 17 00:00:00 2001 From: Daniel Henry Date: Sat, 24 Jan 2026 19:05:29 -0600 Subject: [PATCH] Update Readme Signed-off-by: Daniel Henry --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index e69de29..e5e907e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,22 @@ +# Dumpy + +A simple tool for dumping a directory in a way that an LLM can understand it for adding to the context of a conversation. By default it recursively dumps from the current directory into the clipboard. + +# Installation + +# Usage +``` +usage: dumpy.py [-h] [--no-gitignore] [--include-git-dir] [--no-clipboard] [--no-stats] + +Dumpy: A tool for providing a text representation of a project formatted in a way that LLMs will understand. + +options: + -h, --help show this help message and exit + --no-gitignore Ignore the .gitignore file and include all files + --include-git-dir Include the .git directory in the output + --no-clipboard Skip putting content into the clipboard and ouput directly to the console + --no-stats Skip printing stats at the end of the output + ``` + +# Notes +- Token estimation is really bad, it's just the number of total characters divided by 4 \ No newline at end of file