Skip to content

Commit 4e00ba4

Browse files
committed
some readme updates
1 parent b23b8fe commit 4e00ba4

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
11
# setup-dhall
22

3-
Github action to install a specific version of https://dhall-lang.org and run commands
3+
Github action to install a specific version of https://dhall-lang.org.
44

5-
## Inputs
5+
This will add the following executables to your `PATH`, making them available for further actions:
66

7-
### `version`
7+
- `dhall`
8+
- `dhall-to-json`
9+
- `dhall-to-yaml`
10+
- `json-to-dhall`
11+
12+
### Inputs
13+
14+
#### `version`
815

916
**Optional** The version of Dhall to install. Default: `latest`.
1017

11-
## Usage
18+
### Usage
19+
20+
#### Basic Example
21+
22+
```yaml
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- uses: craig-day/setup-dhall@v2
28+
- run: dhall version
29+
```
1230
13-
### Basic Example
31+
#### With a Specific Version
1432
1533
```yaml
1634
jobs:
@@ -19,7 +37,7 @@ jobs:
1937
steps:
2038
- uses: craig-day/setup-dhall@v2
2139
with:
22-
version: 1.24.0
40+
version: '1.28.0'
2341
- run: dhall version
2442
- run: dhall-to-json --version
2543
```

0 commit comments

Comments
 (0)