From 1147e31aae5d476b3139b45a6f4ced88f1844d01 Mon Sep 17 00:00:00 2001
From: Sascha Mann <git@mail.saschamann.eu>
Date: Sun, 26 Dec 2021 15:27:55 +0100
Subject: [PATCH] Document inputs and outputs

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index ca485f0..a86abe8 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,29 @@ Using this action is equivalent to including the following step in your workflow
       ${{ runner.os }}-
 ```
 
+## Usage
+
+### Inputs
+
+```yaml
+- uses: julia-actions/cache-artifacts@v1
+  with:
+    # The cache name is used as part of the cache key.
+    # It is equivalent to the cache-name environment variable in the snippet above.
+    #
+    # Default: cache-artifacts
+    cache-name: ''
+```
+
+### Outputs
+
+```yaml
+outputs:
+  # A boolean value to indicate an exact match was found for the primary key.
+  # Forwarded from actions/cache, check its documentation for more info.
+  cache-hit: ''
+```
+
 ## Third Party Notice
 
 This action is built around [`actions/cache`](https://github.com/actions/cache/) and includes parts of that action. `actions/cache` has been released under the following licence: