From ef483edf2799e665cc2af1fc0ac231598c8e1f11 Mon Sep 17 00:00:00 2001 From: Sergio Gasquez Date: Wed, 29 Mar 2023 10:56:19 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20Add=20note=20about=20Git?= =?UTF-8?q?hub=20api?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 254953b..e971f8c 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ espup install > **Warning** > -> The generated export file, by default `export-esp`, needs to be sourced in every terminal in Unix systems before building an application. In Windows, environment variables are automatically injected into your system and don't need to be sourced. +> The generated export file, by default `export-esp`, needs to be sourced in every terminal in Unix systems before building an application. On Windows, environment variables are automatically injected into your system and don't need to be sourced. ### Uninstall @@ -115,6 +115,11 @@ Options: > #### Xtensa Rust destination path > Installation paths can be modified by setting the environment variables [`CARGO_HOME`](https://doc.rust-lang.org/cargo/reference/environment-variables.html) and [`RUSTUP_HOME`](https://rust-lang.github.io/rustup/environment-variables.html) before running the `install` command. By default, toolchains will be installed under `/toolchains/esp`, although this can be changed using the `-a/--name` option. +> **Note** +> +> #### GitHub API +> During the installation, we do a few GitHub queries, [which has some limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting). Our number of queries should not hit the limits unless you are running `espup install` command numerous times in a short span of time. We recommend setting the [`GITHUB_TOKEN` environment variable](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) when using `espup` in CI, if you want to use `espup` on CI, recommend using it via the [`xtensa-toolchain` action](https://github.com/esp-rs/xtensa-toolchain/), and making sure `GITHUB_TOKEN` is not set when using it on a host machine. See https://github.com/esp-rs/xtensa-toolchain/issues/15 for more details on this. + ``` Usage: espup install [OPTIONS]