From a1af6fb97032ee6e115cdacd6b2c9b2f43baf0ee Mon Sep 17 00:00:00 2001 From: James Ives Date: Wed, 4 May 2022 17:17:35 -0400 Subject: [PATCH] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f7647f6f..12bf2e51 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,10 @@ on: It's recommended that you use [Dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically) to keep your workflow up-to-date and [secure](https://github.com/features/security). You can find the latest tagged version on the [GitHub Marketplace](https://github.com/marketplace/actions/deploy-to-github-pages) or on the [releases page](https://github.com/JamesIves/github-pages-deploy-action/releases). +#### Security Settings + +If you do not supply the action with an access token or an SSH key, you must access your repositories settings and provide `Read and Write PErmissions` to the provided `GITHUB_TOKEN`, otherwise you'll potentailly run into permission issues. + #### Install as a Node Module 📦 If you'd like to use the functionality provided by this action in your own action you can either [create a composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), or you can install it using [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/get-npm) by running the following commands. It's available on both the [npm](https://www.npmjs.com/package/@jamesives/github-pages-deploy-action) and [GitHub registry](https://github.com/JamesIves/github-pages-deploy-action/packages/229985).