Documentation update - add recommended permissions to Readme (#2043)

* Update README.md

* Update README.md

Co-authored-by: Josh Gross <[email protected]>

---------

Co-authored-by: Josh Gross <[email protected]>

Author: benwells

README.md

@@ -311,6 +311,16 @@ jobs:
           git commit -m "generated"
           git push
 ```
+
+## Recommended permissions
+
+When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs:
+
+```yaml
+permissions:
+  contents: read
+```
+
 *NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D