document cache-hit output

fixes #5
2021-01-28 18:40:43 +01:00 · 2021-01-28 18:40:43 +01:00 · 958028d559
parent 27793b3b80
commit 958028d559
1 changed files with 6 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -28,6 +28,12 @@ An additional key that is stable over multiple jobs.
 The working directory the action operates in, is case the cargo project is not
 located in the repo root.

+## Outputs
+
+: `cache-hit`
+
+This is a boolean flag that will be set to `true` when there was an exact cache hit.
+
 ## Cache Effectiveness

 This action only caches the _dependencies_ of a crate, so is more effective if