docs: add note about documentation in README (#6)

Reviewed-on: https://codeberg.org/vlw/scaffold/pulls/6
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
This commit is contained in:
Victor Westerlund 2025-11-01 16:26:41 +01:00 committed by Victor Westerlund
parent e1d3a09966
commit 3c8c8561b2

View file

@ -9,3 +9,9 @@ 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;
```