From 091dedabf4aecf31be74dd1164287ba5d32c23e1 Mon Sep 17 00:00:00 2001 From: Imani Manyara Date: Sat, 3 Oct 2026 15:17:23 -0400 Subject: [PATCH] Rename the quick start to Quick start guide and usage The README standard now splits the section into Getting started, the setup a fresh install needs before the first call, and Usage. Every command, tag and env key shown was checked against the package's own provider, config or CLI. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e8c0ce..db1dfcb 100755 --- a/README.md +++ b/README.md @@ -16,7 +16,20 @@ Requires PHP `^8.4.1 || ^8.5` and Laravel `^13.0`. composer require laranail/git-commit-checker ``` -## Quick start +## Quick start guide and usage + +### Getting started + +1. Run it from a Git checkout in a local environment: `git-commit-checker:install` refuses to write + a hook when `APP_ENV` is not `local` or there is no `.git` directory. +2. Optionally publish the config to change the hooks or the Pint presets. The pre-commit check is on + by default; `GIT_COMMIT_CHECKER_ENABLED=false` switches it off. + + ```bash + php artisan vendor:publish --tag=laranail::git-commit-checker-config + ``` + +### Usage ```bash # Write .git/hooks/pre-commit and, optionally, a pint.json preset