scaffold/README.md
vlw 3c8c8561b2 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>
2025-11-01 16:26:41 +01:00

17 lines
No EOL
878 B
Markdown

# Scaffold
This composer package contains my project boilerplate code for working with [Vegvisir](https://vegvisir.vlw.se) and [Reflect](https://reflect.vlw.se) projects. It contains my most commonly used classes and functions which I use to make development of new project in these frameworks easier.
Refer to the documentation in each source file for more information about its function.
# Installation
Run the install scripts for [Vegvisir](https://vegvisir.vlw.se/install) and/or [Reflect](https://reflect.vlw.se/install), and then require this composer package to use its features anywhere in your project.
```
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;
```