From 234de5648e7d3aef779d80286d87232f32387381 Mon Sep 17 00:00:00 2001 From: Pauli Jokela Date: Tue, 29 Oct 2019 21:48:32 +0200 Subject: [PATCH] Update README.md --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 04dc193..e902e39 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,17 @@ Provides [Swift](https://swift.org) support for [GitHub Actions](https://github.com/features/actions). -## Usage +## Inputs -To begin using this action, you only need to define `args` in the GitHub Action, which will be automatically forwarded to the `swift` binary (eg. `swift `). +### `swift-action` -If you need more control over the process, you can define `runs` instead, which will override the `swift` binary (eg. ` `). +**Required** Swift action to run. Default `"build"`. -```hcl -workflow "main" { - on = "push" - resolves = ["swift_build"] -} +## Usage -action "swift_build" { - uses = "Didstopia/SwiftAction@v1.0.0" - args = "build" -} -``` +uses: Didstopia/SwiftAction@v1.0.1 +with: + swift-action: 'build' To use the latest development version of this action, change the version number to `master` (eg. `Didstopia/SwiftAction@master`).