From e377f289f7a788dfee1575261e8332b8f0f0e0ec Mon Sep 17 00:00:00 2001 From: ok-nick Date: Sat, 30 Dec 2023 00:28:53 -0500 Subject: [PATCH] docs: more info and fix typo --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d39fca5..a499d78 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,10 @@ There are a few reasons you may choose to enable caching: * A large amount of tools to install * Server downloading from is slow +In any case, it is recommended to benchmark before enabling this feature. + ### `token` -Set to a GitHub token to be used by `aftman` to increase the GitHub rate-limit. Note, these two options, `${{ github.token }}` and `${ secrets.GITHUB_TOKEN}`, are equivalent and passed by default. **Thus, you do not need to specify this parameter unless you are using a token different from the owner of the repository.** +Set to a GitHub token to be used by `aftman` to increase the GitHub rate-limit. Note, these two options, `${{ github.token }}` and `${{ secrets.GITHUB_TOKEN }}`, are equivalent and passed by default. **Thus, you do not need to specify this parameter unless you are using a token different from the owner of the repository.** ## Credits [@nezuo](https://github.com/nezuo) - Installing `aftman` using `gh`