Skip to content

Commit

Permalink
update description
Browse files Browse the repository at this point in the history
  • Loading branch information
idleberg committed Jun 18, 2022
1 parent d715406 commit 0fbb45e
Showing 1 changed file with 13 additions and 29 deletions.
42 changes: 13 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,32 @@

## Usage

Configure a step that adds the `idleberg/setup-playdate-sdk` action to your workflow. Optionally, you can pass the following parameters via `with`
Configure a step that adds the `idleberg/setup-playdate-sdk` action to your workflow. Optionally, you can pass arguments to the action.

**Example**

```yaml
jobs:
steps:
- uses: idleberg/[email protected]
with: # the following options use the defaults
install_sdk: 'true'
sdk_version: 'latest'
set_env_var: 'true'
update_path: 'true'
- uses: idleberg/[email protected]
with:
'1.11.1'
```
See [`test.yml`](https://github.com/idleberg/setup-playdate-sdk/blob/main/.github/workflows/test.yml) for a real-world example.

### Options
## All options

#### install_sdk
### List of input options

Default: `true`
Every argument is optional.

Install Playdate SDK if true

#### sdk_version

Default: `latest`

Specify the version of the SDK

#### set_env_var

Default: `true`

Set `PLAYDATE_SDK_PATH` environment variable

#### update_path

Default: `true`

Update environment variable PATH for workflow if true
| Input | Description | Default |
| ------------- | ----------------------------------------------------- | -------- |
| `install-sdk` | Installs Playdate SDK | `true` |
| `sdk-version` | Specifies the version of the SDK | `latest` |
| `set-env-var` | Sets `PLAYDATE_SDK_PATH` environment variable | `true` |
| `update-path` | Update environment variable PATH for workflow if true | `true` |

## License

Expand Down

0 comments on commit 0fbb45e

Please sign in to comment.