From 3d4567b16c87a492be319c2e2733a830f5d52cc9 Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Mon, 4 May 2020 18:03:15 +0900 Subject: [PATCH] Update README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a239341..0f07c8e 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,14 @@ A GitHub action to create a repository dispatch event. event-type: my-event ``` -## Parameters +### Action inputs -- `token` (**required**) - A `repo` scoped GitHub [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). -- `repository` - The full name of the repository to send the dispatch. Defaults to the current repository. -- `event-type` (**required**) - A custom webhook event name. -- `client-payload` - JSON payload with extra information about the webhook event that your action or workflow may use. Default: {} +| Name | Description | Default | +| --- | --- | --- | +| `token` | (**required**) A `repo` scoped GitHub [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | | +| `repository` | The full name of the repository to send the dispatch. | `github.repository` (current repository) | +| `event-type` | (**required**) A custom webhook event name. | | +| `client-payload` | JSON payload with extra information about the webhook event that your action or workflow may use. | `{}` | ## Example