document deploy script usage in readme

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>
This commit is contained in:
Paul Trowbridge 2026-01-06 22:03:14 -05:00
parent 0ecb6860bd
commit b0f104927c

View File

@ -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 ...
```