From 9fffe05b889362379cc9bae8114b76bac60accbf Mon Sep 17 00:00:00 2001
From: Kevin Stillhammer <kevin.stillhammer@gmail.com>
Date: Mon, 13 Jan 2025 15:32:41 +0100
Subject: [PATCH] Add documentation for new inputs uv-file and pyproject-file
 (#235)

---
 README.md | 37 +++++++++++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e29a91e..b996bb2 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,20 @@ Set up your GitHub Actions workflow with a specific version of [uv](https://docs
 
 ## Usage
 
-### Install the latest version (default)
+### Install a required-version or latest (default)
+
+```yaml
+- name: Install the latest version of uv
+  uses: astral-sh/setup-uv@v5
+```
+
+If you do not specify a version, this action will look for a [required-version](https://docs.astral.sh/uv/reference/settings/#required-version)
+in a `uv.toml` or `pyproject.toml` file in the repository root. If none is found, the latest version will be installed.
+
+For an example workflow, see
+[here](https://github.com/charliermarsh/autobot/blob/e42c66659bf97b90ca9ff305a19cc99952d0d43f/.github/workflows/ci.yaml).
+
+### Install the latest version
 
 ```yaml
 - name: Install the latest version of uv
@@ -39,9 +52,6 @@ Set up your GitHub Actions workflow with a specific version of [uv](https://docs
     version: "latest"
 ```
 
-For an example workflow, see
-[here](https://github.com/charliermarsh/autobot/blob/e42c66659bf97b90ca9ff305a19cc99952d0d43f/.github/workflows/ci.yaml).
-
 ### Install a specific version
 
 ```yaml
@@ -70,6 +80,25 @@ to install the latest version that satisfies the range.
     version: "0.4.x"
 ```
 
+### Install a required-version
+
+You can specify a [required-version](https://docs.astral.sh/uv/reference/settings/#required-version)
+in either a `uv.toml` or `pyproject.toml` file:
+
+```yaml
+- name: Install required-version defined in uv.toml
+  uses: astral-sh/setup-uv@v5
+  with:
+    uv-file: "path/to/uv.toml"
+```
+
+```yaml
+- name: Install required-version defined in pyproject.toml
+  uses: astral-sh/setup-uv@v5
+  with:
+    pyproject-file: "path/to/pyproject.toml"
+```
+
 ### Python version
 
 You can use the input `python-version` to