Skip to content

Commit 0eb4235

Browse files
committed
name workflow; update readme formatting
1 parent 631373b commit 0eb4235

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

.github/workflows/main.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
name: Example Workflow
2+
13
on: push
24

35
jobs:

README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,16 @@ This will add the following executables to your `PATH`, making them available fo
1111
- `dhall-to-yaml`
1212
- `json-to-dhall`
1313

14-
### Inputs
14+
## Inputs
1515

1616
| Parameter | Description | Required | Default |
1717
| -------------- | --------------------------------------------------------------------- | -------- | -------- |
1818
| `version` | The version of Dhall to install | N | `latest` |
1919
| `github_token` | A GitHub Token. This can help with rate limits when fetching releases | N | None |
2020

21-
#### `version`
21+
## Usage
2222

23-
### Usage
24-
25-
#### Basic Example
23+
### Basic Example
2624

2725
```yaml
2826
jobs:
@@ -33,7 +31,7 @@ jobs:
3331
- run: dhall version
3432
```
3533
36-
#### With a Specific Version
34+
### With a Specific Version
3735
3836
```yaml
3937
jobs:
@@ -47,7 +45,7 @@ jobs:
4745
- run: dhall-to-json --version
4846
```
4947
50-
#### Adding a GitHub token
48+
### Adding a GitHub token
5149
5250
If the action fails, it could be because GitHub rate limits anonymous requests to the API. In that
5351
case, the action will log an error message that looks something like this:
@@ -73,7 +71,7 @@ jobs:
7371
- run: dhall-to-json --version
7472
```
7573

76-
### TODO
74+
## TODO
7775

7876
- [x] Add platform validation on action to fail early if an unsupported runner is used
7977
- [x] Add support for the macOS runner

0 commit comments

Comments
 (0)