From 263882fd427a6f9a4bdfc4d409a4ffdcc2b165db Mon Sep 17 00:00:00 2001
From: James Smith <james@cloudstroller.xyz>
Date: Fri, 22 Aug 2025 21:48:01 +0200
Subject: [PATCH] Update readme to include better install instructions

---
 README.md | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 01f82b0..fab9e60 100644
--- a/README.md
+++ b/README.md
@@ -14,20 +14,29 @@ git fetch --all --prune  # prune is to delete unnecessary remote refs
 git merge origin/main main --ff-only
 git branch --merged | grep -v main | xargs git branch -d
 ```
-
 with some extra convenience and (I hope) safety features.
 
 ## Using
 
-The actual script is named `git-tidy`. After cloning, you can copy (or symlink)
-it to somewhere on your path (I use `~/bin/`).
+The actual script is named `git_tidy.py`. After cloning, you can copy (or symlink)
+it to somewhere on your path (e.g. `~/bin/git-tidy`).
+
+Alternatively, you can use a package manager such as
+[`uv`](https://docs.astral.sh/uv/concepts/tools/). My personal preference is
+this, as `uv` will place the tool on the PATH for you and you can get straight
+to using it.
+
+```bash
+uv tool install https://codeberg.org/james-smith-za/git-tidy-python.git
+```
 
 Then when you `cd` to your git repository, you can type
 ```bash
 git tidy
 ```
 and it'll do its thing! Only the Python standard library is used, no additional
-packages are required.
+packages are required. I have tested (manually) with Python 3.8 through to
+3.13, so I would imagine that future versions should work just fine.
 
 ## Background
 
@@ -36,7 +45,6 @@ redo this program in Go at some point, which will make it easier to distribute
 for people who don't have Python installed by default (i.e. Windows users). But
 I'm not sure when I'll get to that.
 
-
 ## TODO
 
 I'd like to actually get a set of unit-tests in place, but I'm not sure how to