From 1eb4120970b6dab07055ac7760c63df4f27c4178 Mon Sep 17 00:00:00 2001
From: Justin Mitchell <justin@jmitch.com>
Date: Sun, 22 Feb 2026 18:42:25 -0500
Subject: [PATCH] Document automated versioning and release process

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 590bb28..30dd68d 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,31 @@ make remove
 
 See [`calibre-customize` docs](https://manual.calibre-ebook.com/generated/en/calibre-customize.html) for more options.
 
+### Releasing
+
+The version is read from the `version` tuple in `crosspoint_reader/driver.py`.
+
+```sh
+# Bump the version (updates driver.py in place)
+make bump-patch   # 1.0.0 -> 1.0.1
+make bump-minor   # 1.0.0 -> 1.1.0
+make bump-major   # 1.0.0 -> 2.0.0
+
+# Package the plugin into a zip (crosspoint_reader-vX.Y.Z.zip)
+make zip
+
+# Create a GitHub release with the zip attached (runs `make zip` first)
+make release
+```
+
+`make release` uses the [GitHub CLI](https://cli.github.com/) (`gh`) to create a tagged release with auto-generated notes.
+
+Typical workflow:
+
+1. `make bump-patch` (or `bump-minor` / `bump-major`)
+2. Commit the version change
+3. `make release`
+
 ### Project structure
 
 ```