diff --git a/README.md b/README.md index 07a01f7..e506c69 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,12 @@ The [`tar` file][tar] must: # File Permissions -When using this action ensure your files have appropriate file permission, we expect at a minimum for the files to have permission for the current user (e.g 0744). -Failure to do so will result in a `deployment_perms_error` when attempting to deploy your artifacts. +When using this action, ensure that your files have appropriate file permissions. +At a minimum, GitHub Pages expects: +- files to have read permission for the current user and the "Others" user role (e.g. `0744`, `0644`, `0444`) +- directories to have read and execute permissions for the current user and the "Others" user role (e.g. `0755`, `0555`) + +Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages. ```yaml ...