Skip to content

Commit 8cb5e82

Browse files
committed
docs: update install instructions for PyPI release
1 parent 51d535a commit 8cb5e82

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
55
[![CI](https://github.com/Mresyzz/opsscript-gate/actions/workflows/test.yml/badge.svg)](https://github.com/Mresyzz/opsscript-gate/actions/workflows/test.yml)
66
[![Demo](https://github.com/Mresyzz/opsscript-gate/actions/workflows/demo.yml/badge.svg)](https://github.com/Mresyzz/opsscript-gate/actions/workflows/demo.yml)
7+
[![PyPI](https://img.shields.io/pypi/v/opsscript-gate)](https://pypi.org/project/opsscript-gate/)
8+
[![Python Versions](https://img.shields.io/pypi/pyversions/opsscript-gate)](https://pypi.org/project/opsscript-gate/)
79
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-OpsScript%20Gate-blue?logo=github&color=2088FF)](https://github.com/marketplace/actions/opsscript-gate)
810
[![Release](https://img.shields.io/github/v/release/Mresyzz/opsscript-gate?color=green)](https://github.com/Mresyzz/opsscript-gate/releases)
9-
[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
1011
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1112
[![Supported Distros](https://img.shields.io/badge/matrix-Debian%20%7C%20Ubuntu%20%7C%20Alpine-orange.svg)](#default-test-matrix)
1213

@@ -26,7 +27,7 @@ Add one step to your pull request workflow (`.github/workflows/gate.yml`):
2627

2728
```yaml
2829
- name: Verify Shell Script Portability
29-
uses: Mresyzz/opsscript-gate@v0.1.1
30+
uses: Mresyzz/opsscript-gate@v0.1.2
3031
with:
3132
script-path: scripts/setup.sh
3233
```
@@ -36,7 +37,10 @@ Add one step to your pull request workflow (`.github/workflows/gate.yml`):
3637
Requires Python 3.10+ and a local Docker engine:
3738
3839
```bash
39-
# Install directly from GitHub
40+
# Install from PyPI
41+
pip install opsscript-gate
42+
43+
# Latest development version
4044
pip install git+https://github.com/Mresyzz/opsscript-gate.git
4145

4246
# Run compatibility gate against your script
@@ -195,6 +199,17 @@ pytest -v
195199

196200
---
197201

202+
## Current limitations
203+
204+
- Requires access to a Docker daemon.
205+
- Scripts are currently executed with `/bin/sh`, regardless of their shebang.
206+
- Distribution runs are currently sequential.
207+
- Containers use bridge networking by default.
208+
- Failure reports currently include only a tail of captured output.
209+
- OpsScript Gate checks runtime execution and exit status; it does not validate application-specific outcomes.
210+
211+
---
212+
198213
## Roadmap
199214

200215
See [ROADMAP.md](ROADMAP.md) for planned capabilities, including:

0 commit comments

Comments
 (0)