From 720e69c948191660a90aa1cf6a42fc4d2dacdf30 Mon Sep 17 00:00:00 2001 From: Sion Kang Date: Tue, 5 Mar 2024 16:40:18 +0900 Subject: [PATCH] docs: New version notation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c8ff7375..12ba68b0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # local-cache -Github Action to provide caching data by placing a tarball on the local filesystem. The goal of this action is to speed up saving and restoring of the cache and remove the http overhead that occurs when using the `actions/cache` action. +GitHub Actions to provide caching data by placing a tarball on the local filesystem. The goal of this action is to speed up saving and restoring of the cache and remove the http overhead that occurs when using the `actions/cache` action. This action is designed for use with runners that have persistent storage. Please only use this action with self-hosted runners that have a persistent volume. It will not work properly on GitHub hosted runners or runners with ephemeral storage, as the cache will be deleted upon job completion. ## Usage @@ -22,11 +22,11 @@ jobs: runs-on: self-hosted steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Cache Primes id: cache-primes - uses: maxnowack/local-cache@v1 + uses: maxnowack/local-cache@v2 with: path: prime-numbers key: ${{ runner.os }}-primes