From 359c8a486f28bd5b60a9fd17fcff1b26f1ec6774 Mon Sep 17 00:00:00 2001 From: Mansab Uppal Date: Tue, 24 Sep 2024 11:16:48 +0200 Subject: [PATCH] Update documentation for using Github app for authentication --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bcd53da..4864513 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ it can be provided by **either** of the following methods: * You will need to set: `GITHUB_TOKEN=""` as the environment variable. #### Github APP (Recommened) -* [Create a Github APP](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) and grant Read-Only access to Github Actions +* [Use cctray-auth Github APP](https://github.com/apps/cctray-auth) to grant Read-Only access to Github Actions on your repositories. * The Github APP should be installed on the Github Organization or Account with access to the required repositories. * You will need to set the following environment variables: ``` @@ -39,7 +39,7 @@ APP_AUTH_ID= APP_AUTH_PRIVATE_KEY_B64= APP_AUTH_INSTALLATION_ID= ``` -* Please refer to Github's offical documentation to know what these values are and where can you find them +* Please refer to [Github's offical documentation](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) to know what these values are and where can you find them **Please take into account the [Github API rate limit](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting) for authentication tokens.**