Skip to content

Document uv support in README - #1489

Open
johnthagen wants to merge 1 commit into
mainfrom
refactor-readme
Open

johnthagen wants to merge 1 commit into
mainfrom
refactor-readme

Document uv support

7bbab50
Select commit
Loading
Failed to load commit list.
Knope Bot / Require changes to be documented required action Sep 24, 2026

This pull request has not been documented yet

This project requires changes to be documented via either changesets or conventional commits. Depending on how this pull request is merged, it may not be fully documented:

  • ❌ Squash merging is allowed, but the title is not a conventional commit
  • ✅ Merge commits are disabled
  • ✅ Rebase merging is disabled

To satisfy this check, you can:

  • Address the conventional commit issues above
  • Click one of the buttons on this screen to auto-generate a change file (may only be visible to maintainers)
  • Create a change file with the Knope CLI
  • Create a change file in GitHub's web editor or copy/paste the content below into .changeset/document_uv_support_in_readme.md
    • Replace "CHANGE_TYPE" with major, minor, or patch (see knope's docs), then edit as needed for your users.

Details

---
default: CHANGE_TYPE
---

# Document uv support in README

#1489 by @johnthagen

Document 

- #1286

And highlight JSON blocks.

We should also probably consider recommending `uv tool` over `pipx` but that could be a follow on depending on decision from @dbanty 

- https://docs.astral.sh/uv/guides/tools/