From 8fb237410939cfbaed560042b8c866d5023ea9a5 Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Sun, 30 Aug 2020 11:20:42 +0900 Subject: [PATCH] docs: update readme --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 284e0ed..6077b24 100644 --- a/README.md +++ b/README.md @@ -147,13 +147,12 @@ To create a project card for the pull request, pass the `pull-request-number` st ## Reference Example -The following workflow is a reference example that sets many of the main inputs. +The following workflow sets many of the action's inputs for reference purposes. +Check the [defaults](#action-inputs) to avoid setting inputs unnecessarily. See [examples](docs/examples.md) for more realistic use cases. ```yml -name: Create Pull Request -on: push jobs: createPullRequest: runs-on: ubuntu-latest