From f1b9fcb59f69523abb3da7780842add149f2d620 Mon Sep 17 00:00:00 2001 From: "Victor M." Date: Tue, 23 Jan 2024 12:23:48 +0100 Subject: [PATCH] Add mention to the required Github token scope --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0793b58b..8ce04522 100644 --- a/README.md +++ b/README.md @@ -54,11 +54,16 @@ python3 -m venv $VENV_DIR pip install crc-bonfire ``` -To prevent GitHub rate limiting issues when bonfire reaches out to GitHub APIs, [create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) on your GitHub account which grants bonfire read access to your repos. Configure bonfire to use the token with: +To prevent GitHub rate limiting issues when bonfire reaches out to GitHub APIs, +[create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) +on your GitHub account which grants bonfire read access to your repos. + +Configure bonfire to use the token with: ``` echo 'GITHUB_TOKEN=' >> ~/.config/bonfire/env ``` +**Please note**: When using the Github token (classic), it **must have** the `read:project` scope for the template fetching to work! # Quick Start