Skip to content

Commit 77a3da0

Browse files
committed
docs: add information about pre-built binaries
Add section to README explaining how to download and use standalone binaries built with PyInstaller for Linux, macOS, and Windows.
1 parent e37a26b commit 77a3da0

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,27 @@ pip install .
6969
pip install -e ".[dev]"
7070
```
7171

72+
### Pre-built Binaries (Standalone)
73+
74+
For systems without Python or pip, download standalone executables from the [GitHub Actions artifacts](https://github.com/slauger/check_netscaler/actions/workflows/pyinstaller.yml):
75+
76+
- **Linux**: `check_netscaler-linux`
77+
- **macOS**: `check_netscaler-macos`
78+
- **Windows**: `check_netscaler-windows.exe`
79+
80+
These binaries are built with PyInstaller and include all dependencies. No Python installation required.
81+
82+
```bash
83+
# Linux/macOS example
84+
chmod +x check_netscaler-linux
85+
./check_netscaler-linux --help
86+
87+
# Windows example
88+
check_netscaler-windows.exe --help
89+
```
90+
91+
Binaries are built automatically on every push and are available as workflow artifacts for 30 days.
92+
7293
## Quick Start
7394

7495
```bash

0 commit comments

Comments
 (0)