From b0f104927cccefb91afe2ffc33f7cff27e6d1954 Mon Sep 17 00:00:00 2001
From: Paul Trowbridge <paul@hptrow.me>
Date: Tue, 6 Jan 2026 22:03:14 -0500
Subject: [PATCH] document deploy script usage in readme
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add clear documentation showing:
- deploy.sh with no arguments uses default /opt/jrunner location
- deploy.sh with argument deploys to custom location for testing
- Explain symlink behavior (only for default location)
- Show usage examples for both deployment types

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
---
 readme.md | 26 ++++++++++++++++++++------
 1 file changed, 20 insertions(+), 6 deletions(-)

diff --git a/readme.md b/readme.md
index ec15fda..a52182b 100644
--- a/readme.md
+++ b/readme.md
@@ -36,20 +36,34 @@ cd jrunner
 ./gradlew build
 ```
 
-## deploy system-wide
+## deploy
+
+### using the deploy script (recommended)
 ```
+# Deploy to /opt/jrunner (default, creates system-wide symlink)
+./deploy.sh
+
+# Deploy to custom location (for testing, no symlink)
+./deploy.sh /opt/jrunner-test
+```
+
+The script builds and deploys in one step. When deploying to the default location (`/opt/jrunner`), it creates a symlink at `/usr/local/bin/jrunner` so you can run `jrunner` from anywhere.
+
+### manual deployment
+```
+./gradlew build
 sudo unzip jrunner/build/distributions/jrunner.zip -d /opt/
 sudo ln -sf /opt/jrunner/bin/jrunner /usr/local/bin/jrunner
 ```
 
-Now you can run from anywhere:
+## usage
+
+After deployment to default location:
 ```
 jrunner -scu jdbc:postgresql://... -scn user -scp pass ...
 ```
 
-To update after rebuilding:
+After deployment to custom location:
 ```
-./gradlew build
-sudo rm -rf /opt/jrunner
-sudo unzip jrunner/build/distributions/jrunner.zip -d /opt/
+/opt/jrunner-test/bin/jrunner -scu jdbc:postgresql://... -scn user -scp pass ...
 ```