From 0bbe76e98ba1a8427b0c539570006e803b947fe1 Mon Sep 17 00:00:00 2001 From: Jongseung Lim Date: Thu, 22 Feb 2024 11:54:59 -0500 Subject: [PATCH] docs: update README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f594f1f..bca458c 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ jobs: | `cache` | No | `true` | Whether to cache RPC responses or not. | bool | | `version` | No | `nightly` | Version to install, e.g. `nightly` or `1.0.0`. **Note:** Foundry only has nightly builds for the time being. | string | | `cache-key` | No | `${{ github.job }}-${{ github.sha }}` | The cache key to use for caching. | string | -| `cache-restore-keys` | No | `${{ github.job }}-` | The cache key to use for restoring the cache. | string[] | +| `cache-restore-keys` | No | `[${{ github.job }}-]` | The cache keys to use for restoring the cache. | string[] | ### RPC Caching @@ -74,7 +74,7 @@ For example, to share the cache across two different jobs, you could do somethin with: cache-key: custom-seed-test-${{ github.sha }} cache-restore-keys: |- - custom-seed-test + custom-seed-test- custom-seed- --- - name: Install Foundry @@ -82,13 +82,13 @@ For example, to share the cache across two different jobs, you could do somethin with: cache-key: custom-seed-coverage-${{ github.sha }} cache-restore-keys: |- - custom-seed-coverage + custom-seed-coverage- custom-seed- ``` This will create two different caches, one for each job, but they will share the same cache key prefix. This means that -when restoring the cache in the second job, it will look for caches with keys that start with `custom-seed-`. This -allows you to share the cache across different jobs, or across different workflows if desired. +when restoring the cache in the second job, it will look for caches with keys that start with `custom-seed-` as well. +This allows you to share the cache across different jobs, or across different workflows if desired. #### Deleting Caches