diff --git a/README.md b/README.md index e5e907e..735b431 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,23 @@ 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 +``` +git clone https://git.danhenry.dev/daniel/dumpy.git +cd dumpy +uv tool install . +``` + +# Updating +``` +git clone https://git.danhenry.dev/daniel/dumpy.git +cd dumpy +uv tool install . +``` + +# Uninstalling +``` +uv tool uninstall dumpy +``` # Usage ``` @@ -17,6 +34,6 @@ options: --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 diff --git a/pyproject.toml b/pyproject.toml index b7c5287..39b07db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,3 +9,6 @@ dependencies = [ "pyperclip>=1.11.0", "rich>=14.3.1", ] + +[project.scripts] +dumpy = "dumpy:main" \ No newline at end of file