From 5333af2ca11b4ab5c65070b0fa80aef083d87c5b Mon Sep 17 00:00:00 2001 From: Ahmad Nassri Date: Mon, 14 Dec 2020 12:20:02 -0500 Subject: [PATCH] docs(readme): update readme --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index acf1387d..ede6ac17 100644 --- a/README.md +++ b/README.md @@ -84,12 +84,13 @@ steps: ### Inputs -| input | required | default | description | -| -------------- | -------- | -------------- | --------------------------------------------------- | -| `github-token` | ✔ | `github.token` | The GitHub token used to merge the pull-request | -| `target` | ❌ | `patch` | The version comparison target (major, minor, patch) | -| `command` | ❌ | `merge` | The command to pass to Dependabot | -| `approve` | ❌ | `true` | Auto-approve pull-requests | +| input | required | default | description | +| -------------- | -------- | ------------------------ | --------------------------------------------------- | +| `github-token` | ✔ | `github.token` | The GitHub token used to merge the pull-request | +| `config` | ✔ | `.github/auto-merge.yml` | Path to configuration file *(relative to root)* | +| `target` | ❌ | `patch` | The version comparison target (major, minor, patch) | +| `command` | ❌ | `merge` | The command to pass to Dependabot | +| `approve` | ❌ | `true` | Auto-approve pull-requests | ### Token Scope @@ -104,7 +105,7 @@ The token MUST be created from a user with **`push`** permission to the reposito ### Configuration file syntax -Using the configuration file `.github/auto-merge.yml`, you have the option to provide a more fine-grained configuration. The following example configuration file merges +Using the configuration file *(specified with `config` input)*, you have the option to provide a more fine-grained configuration. The following example configuration file merges - minor updates for `aws-sdk` - minor development dependency updates