Skip to content

Commit 1ee5e34

Browse files
authored
docs: make inputs readable
1 parent ce3f3cc commit 1ee5e34

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,24 @@ jobs:
3434
3535
## Inputs
3636
37-
- `comment`: Post a comment in the pull request conversation with examples. Default is `true`.
38-
- `token` [**Required**]: Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.
37+
### `comment`
3938

40-
## Outputs
39+
**Optional** Post a comment in the pull request conversation with examples.
4140

42-
None.
41+
| Default value | `true` |
42+
|---------------|--------|
43+
44+
### `token`
45+
46+
**Required** Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.
4347

4448
## Contributing
4549

4650
There are few npm tasks that will help you in building and packaging. All commands are prefaced by `npm run`.
4751

4852
- `build`: builds the action.
49-
- `compile`: transpiles TypeScript.
5053
- `clean`: removes `build` directory.
54+
- `compile`: transpiles TypeScript.
5155
- `fix`: fixes lint and format issues.
5256
- `lint`: runs linter and checks format issues.
5357
- `start`: runs the action.

0 commit comments

Comments
 (0)