From 639fe3c3b2e9ad27f22a24d19fcddefb878dd32e Mon Sep 17 00:00:00 2001
From: James Smith <james-smith-za@users.noreply.github.com>
Date: Sat, 28 Jan 2023 22:44:51 +0200
Subject: [PATCH] Tweak things a bit more. Add usage guide to readme.

---
 README.md               | 13 +++++++++++++
 git-tidy.py => git-tidy |  0
 mypy.ini                |  2 +-
 3 files changed, 14 insertions(+), 1 deletion(-)
 rename git-tidy.py => git-tidy (100%)

diff --git a/README.md b/README.md
index cad3445..2d8e6c9 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,19 @@ 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/`).
+
+Then when you `cd` to your git repository, you can type
+```bash
+git tidy
+```
+and it'll do its thing!
+
+## Background
+
 The repo is named with `-python` on the end because I have a vague ambition to
 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
diff --git a/git-tidy.py b/git-tidy
similarity index 100%
rename from git-tidy.py
rename to git-tidy
diff --git a/mypy.ini b/mypy.ini
index b6bd15e..b821c5b 100644
--- a/mypy.ini
+++ b/mypy.ini
@@ -1,4 +1,4 @@
 [mypy]
 python_version = 3.10
 ignore_missing_imports = True
-files = git-tidy.py
+files = git-tidy