Skip to content

Commit

Permalink
Update README for Action description
Browse files Browse the repository at this point in the history
  • Loading branch information
Kleidukos committed Jan 6, 2024
1 parent 2ff7f29 commit 8d5f0b7
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ A CLI tool that retrieves the `tested-with` stanza of a cabal file and formats i

## Usage

Put this in your GitHub Action file
The inputs of the action (under the `with:` stanza) are the following:

* cabal-file:
The path to your cabal file, e.g. somefolder/myproject.cabal. required;
* version: Version of the tool. required;
* windows: Enable Windows runner. not required, defaults to false;
* macos: Enable macOS runner. not required, defaults to false;
* ubuntu: Enable Ubuntu runner. not required, defaults to false.

One of the three OS inputs is required however. See below for an example:

```yaml
jobs:
Expand Down

0 comments on commit 8d5f0b7

Please sign in to comment.