From 3c8c8561b2ca95526f8478f6fad05448230a6d62 Mon Sep 17 00:00:00 2001
From: vlw <victor@vlw.se>
Date: Sat, 1 Nov 2025 16:26:41 +0100
Subject: [PATCH] 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>
---
 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