From 66931ff48175c77be06cbe8be37cccda14cdd8b3 Mon Sep 17 00:00:00 2001 From: Aiqiao Yan <55104035+aiqiaoy@users.noreply.github.com> Date: Fri, 19 Jun 2020 14:43:10 -0400 Subject: [PATCH] Update cache readme to include a link to cache action (#478) Co-authored-by: Aiqiao Yan --- packages/cache/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/cache/README.md b/packages/cache/README.md index de0893d0..2d5aa1a9 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -8,6 +8,8 @@ Note that GitHub will remove any cache entries that have not been accessed in ov ## Usage +This package is used by the v2+ versions of our first party cache action. You can find an example implementation in the cache repo [here](https://github.com/actions/cache). + #### Restore Cache Restores a cache based on `key` and `restoreKeys` to the `paths` provided. Function returns the cache key for cache hit and returns undefined if cache not found. @@ -38,4 +40,5 @@ const paths = [ ] const key = 'npm-foobar-d5ea0750' const cacheId = await cache.saveCache(paths, key) -``` \ No newline at end of file +``` +