Skip to content

Commit

Permalink
docs(readme): update quick start and add example
Browse files Browse the repository at this point in the history
  • Loading branch information
remarkablemark committed Feb 25, 2024
1 parent 5afb111 commit 7e9e376
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,24 @@
## Quick Start

```yaml
name: setup-butler
name: Upload to itch.io
on: push
jobs:
setup-butler:
itchio-upload:
runs-on: ubuntu-latest
steps:
- name: Setup butler
uses: remarkablegames/setup-butler@v1

- name: Upload to itch.io
# https://itch.io/docs/butler/pushing.html
run: butler push directory user/game:channel
env:
BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}
```
The `BUTLER_API_KEY` is your [itch.io API key](https://itch.io/user/settings/api-keys).

## Usage

See [action.yml](action.yml)
Expand All @@ -43,14 +51,18 @@ See [action.yml](action.yml)

### `cli-name`

**Optional**: The butler CLI name. Defaults to `butler`:
**Optional**: The CLI name. Defaults to `butler`:

```yaml
- uses: remarkablegames/setup-butler@v1
with:
cli-name: butler
```

## Examples

- [remarkablegames/inversion](https://github.com/remarkablegames/inversion/blob/master/.github/workflows/release-please.yml)

## Contributions

Contributions are welcome!
Expand Down

0 comments on commit 7e9e376

Please sign in to comment.