Skip to content

Commit

Permalink
docs: make inputs readable
Browse files Browse the repository at this point in the history
  • Loading branch information
jef authored May 26, 2022
1 parent ce3f3cc commit 1ee5e34
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,24 @@ jobs:
## Inputs
- `comment`: Post a comment in the pull request conversation with examples. Default is `true`.
- `token` [**Required**]: Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.
### `comment`

## Outputs
**Optional** Post a comment in the pull request conversation with examples.

None.
| Default value | `true` |
|---------------|--------|

### `token`

**Required** Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.

## Contributing

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

- `build`: builds the action.
- `compile`: transpiles TypeScript.
- `clean`: removes `build` directory.
- `compile`: transpiles TypeScript.
- `fix`: fixes lint and format issues.
- `lint`: runs linter and checks format issues.
- `start`: runs the action.
Expand Down

0 comments on commit 1ee5e34

Please sign in to comment.