document required permissions (#114)

* document required permissions

Signed-off-by: David J. M. Karlsen <david@davidkarlsen.com>

* add link to docs

Signed-off-by: David J. M. Karlsen <david@davidkarlsen.com>

README.md

@@ -40,6 +40,10 @@ on:
 
 jobs:
   release:
+    # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
+    # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout