From 3f2089d613a85a5123af780aa8c8b7a082da8b8e Mon Sep 17 00:00:00 2001 From: vlw Date: Sat, 1 Nov 2025 16:26:05 +0100 Subject: [PATCH] docs: add note about documentation in README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 4eb41ef..361887b 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,10 @@ Run the install scripts for [Vegvisir](https://vegvisir.vlw.se/install) and/or [ ``` composer require vlw/scaffold +``` + +Refer to the code comments in each file for documentation about its function. The base namespace is `vlw\Scaffold` and each class and function can be `use`d that way. For example: + +```php +use vlw\Scaffold\Database\Model; ``` \ No newline at end of file