diff --git a/install/README.md b/install/README.md index 61db6639..05c0a488 100644 --- a/install/README.md +++ b/install/README.md @@ -9,9 +9,8 @@ To install the latest release run: curl -s https://raw.githubusercontent.com/fluxcd/flux2/main/install/flux.sh | sudo bash ``` -**Note**: You may export an env `GITHUB_TOKEN` which is a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) -to avoid running into Github API rate limiting while executing the install script. -This is recommended if you execute the install script multiple times within the same rate limting window. +**Note**: You may want to export the `GITHUB_TOKEN` environment variable using a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) +to avoid GitHub API rate-limiting errors if executing the install script repeatedly during a short time frame. The install script does the following: * attempts to detect your OS