From 0f17b6b7d38aa91cdbb10e52a7bf481379d59abf Mon Sep 17 00:00:00 2001 From: Imani Manyara Date: Sat, 3 Oct 2026 05:33:52 -0400 Subject: [PATCH] Add a Quick start to the README The docs standard makes a Quick start required: one runnable example that shows what the package does in use, right after Install, pointing on to the full walkthrough. Every symbol in the example was checked against src/, config/ and routes/ before it was written down. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 12f7609..93141e4 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,19 @@ EnvKit::set('MAIL_HOST', 'smtp.acme.test'); // atomic · backed-up · audited $debug = EnvKit::getBool('APP_DEBUG', false); // typed read ``` +## Quick start + +```php +use Simtabi\Laranail\EnvKit\Headless\Facades\EnvKit; + +EnvKit::set('MAIL_HOST', 'smtp.acme.test'); // atomic, backed up, audited + +EnvKit::get('MAIL_HOST'); // "smtp.acme.test" +EnvKit::getBool('APP_DEBUG', false); // true / 1 / yes / on → true +``` + +The full walkthrough is in [Programmatic API](docs/tools/programmatic-api.md); everything else is in the [documentation index](#documentation). + ## Documentation Full documentation is at **[opensource.simtabi.com/documentation/laranail/env-kit](https://opensource.simtabi.com/documentation/laranail/env-kit/)** — format-preserving atomic writes, secret redaction + encryption-at-rest, schema validation, the guard/protection policy, the CLI, the interactive TUI, and configuration.