From 4cd89f39206c6df1de38e03d36e8b9a2babe463b Mon Sep 17 00:00:00 2001
From: Sergio Gasquez <sergio.gasquez@gmail.com>
Date: Fri, 24 Nov 2023 09:09:36 +0100
Subject: [PATCH] docs: Update notes and warnings

---
 README.md | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 84db9682..8f23c11b 100644
--- a/README.md
+++ b/README.md
@@ -82,8 +82,7 @@ espup install
 # Windows does not require sourcing any file
 ```
 
-> **Warning**
->
+> [!IMPORTANT]
 > 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.
 
 ## Usage
@@ -119,13 +118,11 @@ Options:
 
 ### Install Subcommand
 
-> **Note**
->
+> [!NOTE]
 > #### 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 `<rustup_home>/toolchains/esp`, although this can be changed using the `-a/--name` option.
 
-> **Note**
->
+> [!NOTE]
 > #### GitHub API
 >  During the installation process, several GitHub queries are made, [which are subject to certain 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 limit 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.