From 5c5165592f507ca4b6105557d1ae13fe6e07be30 Mon Sep 17 00:00:00 2001 From: Gabe Cook Date: Fri, 14 Apr 2023 01:37:12 -0500 Subject: [PATCH] :memo: (readme): Format inputs as a table --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 641306d..f54ee73 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,12 @@ See the [yampl](https://github.com/clevyr/yampl#readme) readme for more details ## Inputs -- `file` - Path to the file that should be patched. -- `values` - List of values to replace in the provided file. -- `commit_message` - If set, this action will invoke [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) with the given commit message. -- `yampl_version` - Yampl version to install +| Name | Description | Required | Default | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------| +| `file` | Path to the file that should be patched. | `true` | | +| `values` | List of values to replace in the provided file. | `true` | | +| `commit_message` | If set, this action will invoke [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) with the given commit message. | `false` | `""` | +| `yampl_version` | The Yampl version to install. | `false` | `latest` | ## Outputs