From f5792db45f6086a184804f823f4197f57d9464a0 Mon Sep 17 00:00:00 2001
From: Sascha Mann <git@mail.saschamann.eu>
Date: Sun, 26 Dec 2021 15:23:34 +0100
Subject: [PATCH] Add README

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 47667e1..ca485f0 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,44 @@
 # cache-artifacts
-A shortcut action to cache Julia artifacts
+A shortcut action to cache Julia artifacts.
+
+Using this action is equivalent to including the following step in your workflows:
+
+```yaml
+- uses: actions/cache@v1
+  env:
+    cache-name: cache-artifacts
+  with:
+    path: ~/.julia/artifacts
+    key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+    restore-keys: |
+      ${{ runner.os }}-test-${{ env.cache-name }}-
+      ${{ runner.os }}-test-
+      ${{ runner.os }}-
+```
+
+## 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:
+
+
+> The MIT License (MIT)
+> 
+> Copyright (c) 2018 GitHub, Inc. and contributors
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.