From c754bf3531513ce6d769b146df01f58ef99e3db0 Mon Sep 17 00:00:00 2001 From: Tom Keller Date: Fri, 16 Feb 2024 10:18:11 -0800 Subject: [PATCH] chore: minor README update --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c56664b..4ca86bf 100644 --- a/README.md +++ b/README.md @@ -87,9 +87,9 @@ based on which values are supplied to the Action: | Assume Role using WebIdentity Token File credentials | | ✔ | ✔ | | | | Assume Role using existing credentials | | ✔ | | ✔ | | -*Note: `role-chaining` is not necessary to use existing credentials in every use -case. If you're getting a "Credentials loaded by the SDK do not match" error, -try enabling this option. +*Note: `role-chaining` is not always necessary to use existing credentials. +If you're getting a "Credentials loaded by the SDK do not match" error, +try enabling this option.* ### Options See [action.yml](./action.yml) for more detail. @@ -243,7 +243,7 @@ If you set the `special-characters-workaround` option, this action will continually retry fetching credentials until we get one that does not have special characters. This option overrides the `disable-retry` and `retry-max-attempts` options. We recommend that you do not enable this option -unless required, because retrying API infinitely until they succeed is not best +unless required, because retrying APIs infinitely until they succeed is not best practice. ## OIDC