readme: install only example

This commit is contained in:
CrazyMax 2023-05-03 17:51:04 +02:00
parent c619ac25e7
commit 1d17dec12c
No known key found for this signature in database
GPG Key ID: 3248E46B6BB8C7F7

View File

@ -45,18 +45,43 @@ jobs:
args: -fq args: -fq
``` ```
If you just want to install UPX:
```yaml
name: upx
on:
push:
jobs:
upx:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v3
-
name: Install UPX
uses: crazy-max/ghaction-upx@v2
with:
install-only: true
-
name: UPX version
run: upx --version
```
## Customizing ## Customizing
### inputs ### inputs
Following inputs can be used as `step.with` keys Following inputs can be used as `step.with` keys
| Name | Type | Default | Description | | Name | Type | Default | Description |
|---------------|---------|-----------|---------------------------------| |----------------|--------|----------|------------------------------------------------------------|
| `version` | String | `latest` | UPX version. Example: `v3.95` | | `version` | String | `latest` | UPX version. Example: `v3.95` |
| `files` | String | | Newline-delimited list of path globs for files to compress | | `files` | String | | Newline-delimited list of path globs for files to compress |
| `args` | String | | Arguments to pass to UPX | | `args` | String | | Arguments to pass to UPX |
| `install-only` | String | `false` | Install upx, but do not run it | | `install-only` | String | `false` | Just install UPX |
## Limitation ## Limitation