From 671f4b23d5308c62fda3cbe36b986a876133cff6 Mon Sep 17 00:00:00 2001 From: Rittik Dasgupta Date: Thu, 17 Oct 2024 18:53:57 +0530 Subject: [PATCH] docs: modify readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c13c135..4017470 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ Here's what it looks like 👇 ## Prerequisites - **Atlan API token** → before you can run the action, you need an [Atlan API token](https://ask.atlan.com/hc/en-us/articles/8312649180049). - +- **Default Write Permission for GITHUB_TOKEN** -> Grant `read` and `write` permissions to the `GITHUB_TOKEN` in your repository to allow the `atlan-action` to seamlessly add or update comments on pull requests. For more details, refer to the [GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions). + ![GITHUB_TOKEN](https://github.com/user-attachments/assets/4a20e27f-fea4-455c-9840-fa96b152b42b) + ## Configure the action 1. Create [repository secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) in your repository: