mirror of
https://github.com/webiny/action-conventional-commits.git
synced 2024-11-23 10:21:51 +01:00
chore: update README
This commit is contained in:
parent
11319c4557
commit
ff0aeef9c0
1 changed files with 2 additions and 21 deletions
23
README.md
23
README.md
|
@ -1,21 +1,2 @@
|
||||||
# Hello world javascript action
|
# Conventional Commits GitHub Action
|
||||||
|
A simple GitHub action that makes sure all commit messages are following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification.
|
||||||
This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
|
|
||||||
|
|
||||||
## Inputs
|
|
||||||
|
|
||||||
### `who-to-greet`
|
|
||||||
|
|
||||||
**Required** The name of the person to greet. Default `"World"`.
|
|
||||||
|
|
||||||
## Outputs
|
|
||||||
|
|
||||||
### `time`
|
|
||||||
|
|
||||||
The time we greeted you.
|
|
||||||
|
|
||||||
## Example usage
|
|
||||||
|
|
||||||
uses: actions/hello-world-javascript-action@v1
|
|
||||||
with:
|
|
||||||
who-to-greet: 'Mona the Octocat'
|
|
||||||
|
|
Loading…
Reference in a new issue