From ea3d98543b2f1e94277daebee1e4e8f696c134b0 Mon Sep 17 00:00:00 2001 From: Imani Manyara Date: Sat, 3 Oct 2026 15:18:57 -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 | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ce44d0..44d798b 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,19 @@ Targets PHP `^8.5` on Laravel `^13`. composer require laranail/validation ``` -## Quick start +## Quick start guide and usage + +### Getting started + +Nothing to configure: the service provider registers itself through package discovery and the +builders work without publishing anything. Publish the config only for the global safety fuse +or the opt-in string rule aliases: + +```bash +php artisan vendor:publish --tag=laranail::validation-config +``` + +### Usage Add `HasFluentRules` to a form request and return fluent rules from `rules()`. The trait is what enables the optimized path — without it the builders still work, they just compile to