From c810f3fe17905ded24546b2f87a338f138cea2cb Mon Sep 17 00:00:00 2001 From: Abe Date: Fri, 22 Mar 2024 15:27:53 -0400 Subject: [PATCH] feat(README): explain reason for fork in README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2a30ad0..555a371 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +This repository is a fork of [pre-commit/action](https://github.com/pre-commit/action) with a key change: +- Uses [uv](https://github.com/astral-sh/uv) instead of pip for installing pre-commit. + +To use this action in your workflows: +```yaml +- name: Run pre-commit + uses: abe-101/pre-commit@v3.0.2 +``` + this action is in maintenance-only mode and will not be accepting new features. generally you want to use [pre-commit.ci] which is faster and has more features.