diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b8988f --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Hello world JavaScript action + +This action prints "Hello World" to the log or "Hello" + the name of a person to greet. + +## Inputs + +### `who-to-greet` + +**Required** The name of the person to greet. Default `"World"`. + +## Outputs + +### `time` + +The time we greeted you. + +## Example usage + +```yaml +uses: actions/hello-world-javascript-action@master +with: + who-to-greet: 'Mona the Octocat' +```