From ed52ce502e0ddb7bfaee4bce49cbe8f66d22b811 Mon Sep 17 00:00:00 2001
From: Daniel Fichtinger <daniel@ficd.sh>
Date: Wed, 16 Jul 2025 01:16:09 -0400
Subject: [PATCH] update docs

---
 README.md | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index bc18a23..999306d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,29 @@
 # uv-cache
 
 This is a very simple action that sets up cache support for `uv`. It doesn't do
-anything else. It's assumed that `uv`, as well as all the dependencies for
-`actions/cache@v4` are available in the container. I wrote this to work well
-with [based-alpine](https://git.ficd.sh/ficd/based-alpine).
+anything else. I wrote this to work well with
+[based-alpine](https://git.ficd.sh/ficd/based-alpine).
+
+## Requirements
+
+All dependencies `actions/cache@v4` must be satisfied, and `uv` must be
+available on the path.
+
+## Usage
+
+Using this action is very simple. We also provide one output: `cache-hit`, which
+is either "true" or "false".
+
+```yaml
+# you should always checkout first
+# otherwise there is nothing to check cache against
+- name: checkout source
+  uses: actions/checkout@v4
+- name: setup cache
+  # assign the id if you want to check the boolean later
+  id: uv-cache
+  uses: https://git.ficd.sh/ficd/uv-cache@v1
+- name: Check cache status
+  run: |
+    echo "Cache hit? ${{ steps.uv-cache.outputs.cache-hit }}"
+```