From c38007a979028c81335df5476b53a0dd7a5985f6 Mon Sep 17 00:00:00 2001 From: Federico Builes Date: Tue, 8 Nov 2022 17:45:23 +0100 Subject: [PATCH] Don't abbreviate repo in docs. In general let's try not to use abbreviations in public documentation. --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ea085cb..cf5bb9e 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,13 @@ or by inlining these options in your workflow file. ### config-file -A string representing the path to a configuraton file. The -configuration file can be local to the repo, or can be a file in an -external repo. If you are referencing a configuration file located in an -external repository, you can use the -`OWNER/REPOSITORY/FILENAME@BRANCH` syntax. +A string representing the path to a configuraton file. It can be a +local file, or a file located in an external repository. You can use +this syntax for external repositories: `OWNER/REPOSITORY/FILENAME@BRANCH`. -If the configuration file is located in an external private -repository, use the [external-repo-token](#external-repo-token) parameter of the action to specify a token that has read access to the repository. +If the configuration file is located in an external private repository, +use the [external-repo-token](#external-repo-token) parameter of the +Action to specify a token that has read access to the repository. **Possible values**: A string representing an absolute path to a file, or a file located in another repository: